Skip to content

Commit

Permalink
chore: update notes about peerDependencies in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kuasha420 committed May 6, 2021
1 parent 968b076 commit 401945c
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ A factory to easily create Persistent Mobx State Tree Store Provider and consume

- [Mobx State Tree Persistent Store](#mobx-state-tree-persistent-store)
- [Installation](#installation)
- [For React](#for-react)
- [For React Native](#for-react-native)
- [Usage](#usage)
- [Create Provider and Hooks](#create-provider-and-hooks)
- [Add Provider to The Root Component](#add-provider-to-the-root-component)
Expand All @@ -16,14 +18,21 @@ A factory to easily create Persistent Mobx State Tree Store Provider and consume
- [Arguments](#arguments)
- [PersistentStoreOptions](#persistentstoreoptions)
- [License](#license)
- [Contribution](#contribution)

## Installation

`yarn add mst-persistent-store`

Install the peerDependencies if you haven't already.

`yarn add mobx-state-tree react`
### For React

`yarn add mobx-state-tree localforage`

### For React Native

`yarn add mobx-state-tree @react-native-async-storage/async-storage`

## Usage

Expand Down Expand Up @@ -168,4 +177,8 @@ All Properties are optional.

## License

MIT
This package is licensed under the MIT License.

## Contribution

Any kind of contribution is welcome. Thanks!

0 comments on commit 401945c

Please sign in to comment.