update doc

Author: plrthink

README.md

@@ -2,22 +2,19 @@
 
 Zip archive utility for react-native
 
+> ### Important
+> If you're using react-native after 0.40.0 on iOS, be sure to use > 0.1.0 of this package.
+
 ## Installation
 
 ```bash
 npm install react-native-zip-archive --save
 ```
 
 ## Getting started - iOS
-
-1. In Xcode, in the project navigator right click `Libraries` ➜ `Add Files to [your project's name]`
-2. Go to `node_modules` ➜ `react-native-zip-archive` and add `RNZipArchive.xcodeproj`
-3. Add `libRNZipArchive.a` (from 'Products' under RNZipArchive.xcodeproj) to your project's `Build Phases` ➜ `Link Binary With Libraries` phase
-4. Add the `libz` library to your target
-5. Look for Header Search Paths and make sure it contains both `$(SRCROOT)/../react-native/React` and `$(SRCROOT)/../../React` - mark both as recursive
-6. Run your project (`CMD+R`)
-
-Warning: If you're using [rnpm](https://github.com/rnpm/rnpm) to link this module, you also need manually link `libz` library to your target otherwise your project wouldn't compile.
+```bash
+react-native link react-native-zip-archive
+```
 
 ## Getting started - Android
 
@@ -74,30 +71,49 @@ Warning: If you're using [rnpm](https://github.com/rnpm/rnpm) to link this modul
 require it in your file
 
 ```js
-const ZipArchive = require('react-native-zip-archive')
+import { zip, unzip, unzipAssets, subscribe } from 'react-native-zip-archive'
 ```
 
 you may also want to use something like [react-native-fs](https://github.com/johanneslumpe/react-native-fs) to access the file system (check its repo for more information)
 
 ```js
-const RNFS = require('react-native-fs')
+import { MainBundlePath, DocumentDirectoryPath } from 'react-native-fs'
 ```
 
 ## API
 
+**zip(source: string, target: string): Promise**
+
+> zip source to target
+
+Example
+
+```js
+const targetPath = `${DocumentDirectoryPath}/myFile.zip`
+const sourcePath = DocumentDirectoryPath
+
+zip(sourcePath, targetPath)
+.then((path) => {
+  console.log(`unzip completed at ${path}`)
+})
+.catch((error) => {
+  console.log(error)
+})
+```
+
 **unzip(source: string, target: string): Promise**
 
 > unzip from source to target
 
 Example
 
 ```js
-let sourcePath = 'path_to_your_zip_file'
-let targetPath = RNFS.DocumentDirectoryPath
+const sourcePath = `${DocumentDirectoryPath}/myFile.zip`
+const targetPath = DocumentDirectoryPath
 
-ZipArchive.unzip(sourcePath, targetPath)
-.then(() => {
-  console.log('unzip completed!')
+unzip(sourcePath, targetPath)
+.then((path) => {
+  console.log(`unzip completed at ${path}`)
 })
 .catch((error) => {
   console.log(error)
@@ -113,10 +129,10 @@ ZipArchive.unzip(sourcePath, targetPath)
 `assetPath` is the relative path to the file inside the pre-bundled assets folder, e.g. `folder/myFile.zip`. Do not pass an absolute directory.
 
 ```js
-const assetPath = 'folder/myFile.zip'
-const targetPath = RNFS.DocumentDirectoryPath
+const assetPath = `${DocumentDirectoryPath}/myFile.zip`
+const targetPath = DocumentDirectoryPath
 
-ZipArchive.unzipAssets(assetPath, targetPath)
+unzipAssets(assetPath, targetPath)
 .then(() => {
   console.log('unzip completed!')
 })
@@ -137,7 +153,7 @@ Your callback will be passed an object with the following fields:
 
 ```js
 componentWillMount() {
-  this.zipProgress = ZipArchive.subscribe((e) => {
+  this.zipProgress = subscribe((e) => {
     this.setState({ zipProgress: e.progress })
   })
 }