Browse Source

Change npm package README.md

Ben Hsieh 8 years ago
parent
commit
613fa6a758
1 changed files with 8 additions and 4 deletions
  1. 8
    4
      src/README.md

+ 8
- 4
src/README.md View File

@@ -4,6 +4,8 @@
4 4
 
5 5
 A project committed to make file acess and data transfer easier, efficient for React Native developers.
6 6
 
7
+# [Please visit our Github Page for latest document](https://github.com/wkh237/react-native-fetch-blob)
8
+
7 9
 ## Features
8 10
 - Transfer data directly from/to storage without BASE64 bridging
9 11
 - File API supports normal files, Asset files, and CameraRoll files
@@ -11,8 +13,6 @@ A project committed to make file acess and data transfer easier, efficient for R
11 13
 - File stream support for dealing with large file
12 14
 - Blob, File, XMLHttpRequest polyfills that make browser-based library available in RN (experimental)
13 15
 
14
-> The npm package is inside `src` folder, if you're going to install via git repository do not directly poiint to this folder
15
-
16 16
 ## TOC
17 17
 * [About](#user-content-about)
18 18
 * [Installation](#user-content-installation)
@@ -157,6 +157,8 @@ To sum up :
157 157
  - Otherwise, if a string starts with `RNFetchBlob-file://` (which can simply done by `RNFetchBlob.wrap(PATH_TO_THE_FILE)`), it will try to find the data from the URI string after `RNFetchBlob-file://` and use it as request body.
158 158
 - To send the body as-is, simply use a `Content-Type` header not containing `;BASE64` or `application/octet`.
159 159
 
160
+> It is Worth to mentioning that the HTTP request uses cache by default, if you're going to disable it simply add a Cache Control header `'Cache-Control' : 'no-store'`
161
+
160 162
 > After 0.9.4, we disabled `Chunked` transfer encoding by default, if you're going to use it, you should explicitly set header `Transfer-Encoding` to `Chunked`.
161 163
 
162 164
 ### Download example : Fetch files that needs authorization token
@@ -268,7 +270,7 @@ RNFetchBlob.fetch('POST', 'https://content.dropboxapi.com/2/files/upload', {
268 270
     }),
269 271
     'Content-Type' : 'application/octet-stream',
270 272
     // here's the body you're going to send, should be a BASE64 encoded string
271
-    // (you can use "base64" APIs to make one).
273
+    // (you can use "base64"(refer to the library 'mathiasbynens/base64') APIs to make one).
272 274
     // The data will be converted to "byte array"(say, blob) before request sent.  
273 275
   }, base64ImageString)
274 276
   .then((res) => {
@@ -709,10 +711,12 @@ Here's a [sample app](https://github.com/wkh237/rn-firebase-storage-upload-sampl
709 711
 
710 712
 ## Performance Tips
711 713
 
712
-**Reduce RCT Bridge and BASE64 Overheard**
714
+**Read Stream Event Overhead**
713 715
 
714 716
 When reading data via `fs.readStream` the process seems blocking JS thread when file is large, it's because the default buffer size is quite small (4kb) which result in large amount of events triggered in JS thread, try to increase the buffer size (for example 100kb = 102400) and set a larger interval (which is introduced in 0.9.4 default value is 10ms) to limit the frequency.
715 717
 
718
+**Reduce RCT Bridge and BASE64 Overhead**
719
+
716 720
 React Native connects JS and Native context by passing JSON around React Native bridge, and there will be an overhead to convert data before they sent to each side. When data is large, this will be quite a performance impact to your app, it's recommended to use file storage instead of BASE64 if possible.The following chart shows how much faster when loading data from storage than BASE64 encoded string on iphone 6.
717 721
 
718 722
 <img src="img/performance_1.png" style="width : 100%"/>