Browse Source

Update README.md

wkh237 8 years ago
parent
commit
89de3b0d90
1 changed files with 7 additions and 3 deletions
  1. 7
    3
      README.md

+ 7
- 3
README.md View File

@@ -2,11 +2,15 @@
2 2
 
3 3
 ## v0.5.0 Work In Progress README.md
4 4
 
5
-Module for upload, download, and access files in JS context. Also has file stream API for read/write large files.
5
+Module for upload, download, and files access in JS context. Supports file stream read/write for process large files.
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
+**Why do we need this**
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 I made this module.
9
+At this moment, React Native does not support `Blob` object yet, so if you're going to send/receive binary data via `fetch` API, that might not work as you expect. See [[fetch] Does fetch with blob() marshal data across the bridge?](https://github.com/facebook/react-native/issues/854). 
10
+
11
+Therefore you may getting into trouble sometime. For example, you're going to display an image but the file server requires a specific field(for example, "Authorization") in headers or body, you can't just pass the image uri to `Image` component because that will probably returns a 401 response. With help of this module, you can send a HTTP request with any headers, and decide how to handle the response data. It can be just simply converted into BASE64 string, or store to a file directly so that you can read it by file stream or use it's path. 
12
+
13
+This module is designed for these kind of purpose, and also be a substitution of `blob`, so there's a set of file access API added after `v0.5.0`, including basic CRUD method, and file stream reader and writer.
10 14
 
11 15
 **Pre v0.5.0 Users**
12 16