[![Release](https://img.shields.io/badge/PreRelease-^0.3.126-success.svg?style=for-the-badge)](https://shields.io/)
[![Maintained](https://img.shields.io/badge/Maintained-Actively-informational.svg?style=for-the-badge)](https://shields.io/)

# sghi_core

`sghi_core` is an open source project &mdash; it's one among many other shared libraries that make up the wider ecosystem of software made and open sourced by `Savannah Informatics Limited`.

Shared library for `BeWell-Consumer` and `SladeAdvantage` that is a wrapper for various shared helper methods and functions

## Installation Instructions

Use this package as a library by depending on it

Run this command:

- With Flutter:\*\*\*\*

```dart
flutter pub add sghi_core
```

This will add a line like this to your package's pubspec.yaml (and run an implicit dart pub get):

```dart
dependencies:
  sghi_core: ^0.3.126
```

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

Lastly:

Import it like so:

```dart
import 'package:sghi_core/app_wrapper/app_wrapper.dart';
```

## Usage

Check the [example](https://github.com/savannahghi/sghi_core/blob/main/example/readme.md) provided for how to use this package.

## Dart & Flutter Version

- Dart 2: >= 3.0.6
- Flutter: >=3.19.2

## Developing & Contributing

First off, thanks for taking the time to contribute!

Be sure to check out detailed instructions on how to contribute to this project [here](https://github.com/savannahghi/sghi_core/blob/main/CONTRIBUTING.md) and go through out [Code of Conduct](https://github.com/savannahghi/sghi_core/blob/main/CODE_OF_CONDUCT.md).

GPG Signing:
As a contributor, you need to sign your commits. For more details check [here](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits)

## License

This library is distributed under the MIT license found in the [LICENSE](https://github.com/savannahghi/sghi_core/blob/main/LICENSE) file.
