Skip to content
This repository was archived by the owner on Jul 2, 2021. It is now read-only.

Commit 73f71c3

Browse files
committed
Updated README
1 parent 695eac8 commit 73f71c3

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22

33
## js-data-asyncstorage [![bower version](https://img.shields.io/bower/v/js-data-asyncstorage.svg?style=flat-square)](https://www.npmjs.org/package/js-data-asyncstorage) [![npm version](https://img.shields.io/npm/v/js-data-asyncstorage.svg?style=flat-square)](https://www.npmjs.org/package/js-data-asyncstorage) [![Circle CI](https://img.shields.io/circleci/project/js-data/js-data-asyncstorage/master.svg?style=flat-square)](https://circleci.com/gh/js-data/js-data-asyncstorage/tree/master) [![npm downloads](https://img.shields.io/npm/dm/js-data-asyncstorage.svg?style=flat-square)](https://www.npmjs.org/package/js-data-asyncstorage) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/lukasreichart/js-data-asyncstorage/blob/master/LICENSE)
44

5-
react-native AsyncStorage adapter for [js-data](http://www.js-data.io/).
5+
[js-data](https://github.com/js-data/js-data) is a very sophisticated data handling library. I'am currently
6+
developing for [react-native](https://facebook.github.io/react-native/) and wanted
7+
to unleash the power of js-data on react-native, so I built this adapter which uses react-native's ```AsyncStorage```
8+
class, instead of a browsers localstorage.
9+
10+
Disclaimer: This is the first version of this adapter. Although the tests are passing there
11+
may be still some bugs hidden somewhere. If you find any, I'd love to hear from you.
612

713
### API Documentation
814
[DSAsyncStorageAdapter](http://www.js-data.io/docs/dsasyncstorageadapter)
915

10-
### Demo
11-
[https://js-data-asyncstorage.firebaseapp.com/](https://js-data-asyncstorage.firebaseapp.com/)
12-
1316
### Project Status
1417

1518
__Latest Release:__ [![Latest Release](https://img.shields.io/github/release/lukasreichart/js-data-asyncstorage.svg?style=flat-square)](https://github.com/lukasreichart/js-data-asyncstorage/releases)
@@ -25,7 +28,7 @@ var adapter = new DSAsyncStorageAdapter();
2528
var store = new JSData.DS();
2629
store.registerAdapter('asyncstorage', adapter, { default: true });
2730

28-
// "store" will now use the asyncstorage adapter for all async operations
31+
// "store" will now use the asyncstorage adapter for all operations
2932
```
3033

3134
### Changelog
@@ -37,11 +40,14 @@ store.registerAdapter('asyncstorage', adapter, { default: true });
3740
- [GitHub](https://github.com/lukasreichart/js-data-asyncstorage) - View the source code for js-data.
3841
- [Contributing Guide](https://github.com/lukasreichart/js-data-asyncstorage/blob/master/CONTRIBUTING.md)
3942

40-
### Contributing
43+
### Features
44+
- Add better testing (tests are currently executed in chrome, because I don't know of an easy way to test in react-native. )
45+
- Create an example app of how to use js-data with react-native.
46+
- ...
4147

4248
# Contributing Guide
4349

44-
First, support is handled via the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
50+
If you have any questions regarding this adapter, feel free to open an issue or write me an email.
4551

4652
When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
4753

0 commit comments

Comments
 (0)