Skip to content

Commit

Permalink
Update document.
Browse files Browse the repository at this point in the history
  • Loading branch information
rob333 committed Oct 29, 2023
1 parent 914b3db commit 0f413b6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ windows/
android/
ios/

.metadata
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,23 +142,37 @@ Flutter mediator is a state management package base on the [InheritedModel][] wi

<hr>

## Setting up
## Getting started

Add the following dependency to pubspec.yaml of your flutter project:
Run this command:

With Flutter:

```
$ flutter pub add flutter_mediator
```

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

```yaml
dependencies:
flutter_mediator: "^2.2.5"
```
Import flutter_mediator in files that will be used:
Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.
### Import it
Now in your Dart code, you can use:
```dart
import 'package:flutter_mediator/mediator.dart';
```

For help getting started with Flutter, view the online [documentation](https://flutter.dev/docs).


&emsp; [Table of Contents]

# Global Mode
Expand Down

0 comments on commit 0f413b6

Please sign in to comment.