Browse Source

Update README.md

wkh237 8 years ago
parent
commit
7707ad848b
1 changed files with 11 additions and 7 deletions
  1. 11
    7
      README.md

+ 11
- 7
README.md View File

2
 
2
 
3
 ## v0.5.0 Work In Progress README.md
3
 ## v0.5.0 Work In Progress README.md
4
 
4
 
5
-A react-native module for upload, and download files with customizable headers. Supports binary response/request data, upload/download progress. It also has a file stream reader API that enables you to handle files in JS context (such as display image data, and process string or data).
5
+Upload, and download files with customzable headers. Supports binary response/request data, upload/download progress, also has file stream, and CRUD APIs which enables you process file content in JS context. (such as display image data, and process string or data).
6
 
6
 
7
 If you're getting into trouble with image or file server that requires specific fields in the header, or you're having problem with `fetch` API when sending/receiving binary data, you might try this module as well.
7
 If you're getting into trouble with image or file server that requires specific fields in the header, or you're having problem with `fetch` API when sending/receiving binary data, you might try this module as well.
8
 
8
 
9
-See [[fetch] Does fetch with blob() marshal data across the bridge?](https://github.com/facebook/react-native/issues/854) for the reason why we made this module.
9
+See [[fetch] Does fetch with blob() marshal data across the bridge?](https://github.com/facebook/react-native/issues/854) for the reason why I made this module.
10
 
10
 
11
-In latest version (v0.5.0), you can either `upload` or `download` files simply using a file path. We've also introduced `file stream` API in this version for reading files (especially for **large ones**) from storage, see [Examples](#user-content-usage) bellow.
11
+In latest version (v0.5.0), you can either `upload` or `download` files simply using a file path. We've also introduced `fs` APIs for access files, and `file stream` API that helps you read/write files (especially for **large ones**), see [Examples](#user-content-usage) bellow.
12
 
12
 
13
-This module implements native HTTP request methods, supports both Android (uses awesome native library  [AsyncHttpClient](https://github.com/AsyncHttpClient/async-http-client])) and IOS.
13
+This module implements native methods, supports both Android (uses awesome native library  [AsyncHttpClient](https://github.com/AsyncHttpClient/async-http-client])) and IOS.
14
 
14
 
15
-## Usage
15
+## TOC
16
 
16
 
17
 * [Installation](#user-content-installation)
17
 * [Installation](#user-content-installation)
18
 * [Examples](#user-content-usage)
18
 * [Examples](#user-content-usage)
20
  * [Upload file](#user-content-upload-example--dropbox-files-upload-api)
20
  * [Upload file](#user-content-upload-example--dropbox-files-upload-api)
21
  * [Multipart/form upload](#user-content-multipartform-data-example--post-form-data-with-file-and-data)
21
  * [Multipart/form upload](#user-content-multipartform-data-example--post-form-data-with-file-and-data)
22
  * [Upload/Download progress](#user-content-uploaaddownload-progress)
22
  * [Upload/Download progress](#user-content-uploaaddownload-progress)
23
- * [File stream reader](#user-content-file-stream-reader)
24
- * [Release cache files](#user-content-release-cache-files)
23
+ * [File stream](#user-content-file-stream)
24
+ * [Manage cached files](#user-content-manage-cached-files)
25
 * [API](#user-content-api)
25
 * [API](#user-content-api)
26
+ * [fetch](#user-content-fetchmethod-url-headers-bodypromisefetchblobresponse)
27
+ * [session](#user-content-sessionnamestringrnfetchblobsession)
28
+ * [base64](#user-content-base64)
29
+ * [fs](#user-content-fs)
26
 * [Development](#user-content-development)
30
 * [Development](#user-content-development)
27
 
31
 
28
 ## Installation
32
 ## Installation