Skip to content
This repository was archived by the owner on Mar 16, 2019. It is now read-only.

Commit 11fe4fb

Browse files
authored
Update README.md
1 parent 51de59d commit 11fe4fb

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,8 @@
22

33
A project committed to make file acess and transfer easier and effiecient for React Native developers.
44

5-
**You will need react-native 0.27+ to use 0.7.0+ version**
6-
75
## TOC
86
* [About](#user-content-about)
9-
* [Backward Compatible](#user-content-backward-compatible)
107
* [Installation](#user-content-installation)
118
* [Recipes](#user-content-recipes)
129
* [Download file](#user-content-download-example--fetch-files-that-needs-authorization-token)
@@ -29,10 +26,6 @@ This project was initially for solving the issue [facebook/react-native#854](htt
2926

3027
Now, this project is committed to make file acess and transfer more easier and more effiecient for React Native developers. We've implemented lot of file access function which plays well with our network module. For example, it can upload and download data directly into/from file system, which is much more performant (especially for large ones) than converting data to BASE64 passing them around through React JS Bridge, also, file stream support so that you can read large file not causing OOM error.
3128

32-
## Backward Compatible
33-
34-
All updates are `backward-compatible` generally you don't have to change existing code unless you're going to use new APIs. But it's recommended pre `0.5.0` users consider upgrade the package to latest version, since we have introduced new APIs can either `upload` or `download` files simply using a file path. It's much more memory efficent in some use case. 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-recipes) bellow. This module implements native methods, supports both Android (uses same native library as offical RN fetch API [OkHttp](https://github.com/square/okhttp)) and IOS.
35-
3629
## Installation
3730

3831
Install package from npm
@@ -47,6 +40,14 @@ Link package using [rnpm](https://github.com/rnpm/rnpm)
4740
rnpm link
4841
```
4942

43+
### To Use 0.7.0+ you will need to upgrade your App to 0.29.2+ (Android)
44+
45+
In `0.7.0` we have removed Android AsyncHttpClient dependency and use OkHttp3+ dependency in react-native, therefore older version project (which uses OkHttp2) will not be compatible. To upgrade your project
46+
47+
```
48+
$ react-native upgrade
49+
```
50+
5051
### Manually link the package (Android)
5152

5253
If rnpm link command failed to link the package automatically, you might try manually link the package.

0 commit comments

Comments
 (0)