You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
(docs): add more links to various systems / APIs described
- MST store & snapshots as well as localStorage & AsyncStorage
- more beginner friendly and easier to get to relevant info from README
- for storage, only linking to localForage made it seem more important
than the others
- also add link to src/ directory in the under the hood as it's felt
like it needs a CTA for a while
- src/ link on master doesn't have a high probability of changing,
so updating that shouldn't be a big concern
Any Storage Engine that has a Promise-style API similar to [`localForage`](https://github.com/localForage/localForage).
58
-
The default is `localStorage`, which has a built-in adaptor to make it support Promises.
59
-
For React Native, one may configure `AsyncStorage` instead.
58
+
The default is [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage), which has a built-in adaptor to make it support Promises.
59
+
For React Native, one may configure [`AsyncStorage`](https://github.com/react-native-community/async-storage) instead.
60
60
<br>
61
61
Any of [`redux-persist`'s Storage Engines](https://github.com/rt2zz/redux-persist#storage-engines) should also be compatible with `mst-persist`.
62
62
-**jsonify***bool* Enables serialization as JSON (default: `true`).
@@ -87,8 +87,8 @@ Can view the commit that implements it [here](https://github.com/agilgur5/react-
87
87
88
88
## How it works
89
89
90
-
Basically just a small wrapper around MST's `onSnapshot` and `applySnapshot`.
91
-
The source code is currently shorter than this README, so take a look under the hood! :)
90
+
Basically just a small wrapper around MST's [`onSnapshot` and `applySnapshot`](https://github.com/mobxjs/mobx-state-tree#snapshots).
91
+
The source code is currently shorter than this README, so [take a look under the hood](https://github.com/agilgur5/mst-persist/tree/master/src)! :)
0 commit comments