Create docs for module

Create docs for module

Author: krizzu

.circleci/config.yml

@@ -0,0 +1,61 @@
+version: 2
+
+# Defaults
+default job config: &defaults
+  working_directory: ~/async_storage
+  docker:
+    - image: circleci/node:8
+
+checkout step for each job: &addWorkspace
+  attach_workspace:
+    at: ~/
+
+
+jobs:
+  "Setup environment":
+    <<: *defaults
+    steps:
+      - checkout
+      - restore_cache:
+          name: Restore node modules
+          keys:
+            - node_modules-{{ checksum "yarn.lock" }}-{{ checksum "package.json" }}-{{ arch }}
+      - run:
+          name: Install dependencies
+          command: yarn --pure-lockfile --non-interactive
+      - save_cache:
+          name: Save node modules
+          key: node_modules-{{ checksum "yarn.lock" }}-{{ checksum "package.json" }}-{{ arch }}
+          paths:
+            - node_modules
+          persist_to_workspace:
+            -root: .
+            -paths: .
+
+  "Test: lint":
+    <<: *defaults
+    steps:
+      - *addWorkspace
+      - run:
+          name: Lint check
+          command: yarn test:lint
+
+  "Test: flow":
+    <<: *defaults
+    steps:
+      - *addWorkspace
+      - run:
+          name: Flow check
+          command: yarn test:flow
+
+workflows:
+  version: 2
+  "Basic check":
+    jobs:
+      - "Setup environment"
+      - "Test: lint":
+          requires:
+            - "Setup environment"
+      - "Test: flow":
+          requires:
+            - "Setup environment"

.eslintrc

@@ -5,6 +5,7 @@
 
   "env": {
     "es6": true,
+    "jest/globals": true
   },
 
   "plugins": [
@@ -14,7 +15,7 @@
     "react",
     "react-hooks",
     "react-native",
-    "jest",
+    "jest"
   ],
 
   // Map from global var to bool specifying if it can be redefined
@@ -50,7 +51,7 @@
     "setInterval": false,
     "setTimeout": false,
     "window": false,
-    "XMLHttpRequest": false,
+    "XMLHttpRequest": false
   },
 
   "rules": {

README.md

@@ -1,24 +1,61 @@
-# react-native-async-storage
+# React Native Async Storage
 
-Asynchronous, persistent, key-value storage system for React Native.
+An asynchronous, persistent, key-value storage system for React Native.
 
-## Getting started
 
+## Getting Started
 
-### Install 
 
-`yarn add @react-native-community/async-storage`
+```
+# Install
+$ yarn add @react-native-community/async-storage
 
-or
+# Link
+$ react-native link @react-native-community/async-storage
+```
 
-`npm install @react-native-community/async-storage --save`
+See docs for [manual linking guide.](docs/Linking.md)
 
 
-### Link
+## Usage
 
-`react-native link @react-native-community/async-storage`
+### Import
 
-## Usage
+```js
+import AsyncStorage from '@react-native-community/async-storage';
+```
+
+### Store data
+```jsx
+
+storeData = async () => {
+  try {
+    await AsyncStorage.setItem('@storage_Key', 'stored value')
+  } catch (e) {
+    // saving error
+  }
+}
+
+```
+
+### Read data 
+```jsx
+
+getData = async () => {
+  try {
+    const value = await AsyncStorage.getItem('@storage_Key')
+    if(value !== null) {
+      // value previously stored
+    }
+  } catch(e) {
+    // error reading value
+  }
+}
+
+```
+
+See docs for [api and more examples.](docs/API.md)
 
-ToDo
+## License
 
+MIT

babel.config.js

@@ -5,7 +5,7 @@ module.exports = {
       'module-resolver',
       {
         alias: {
-          '@react-native-community/asyns-storage': './lib/AsyncStorage',
+          '@react-native-community/async-storage': './lib/AsyncStorage',
         },
         cwd: 'babelrc',
       },