status-im
/
react-native-firebase
mirror of
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Michael Diarmid 2017-03-23 17:05:28 +00:00 committed by GitHub
parent ecde728f85
commit e78c288b40
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,19 +1,25 @@
# React Native Firebase # React Native Firebase<img align="left" src="http://i.imgur.com/01XQL0x.png">
RNFirebase makes using the latest [Firebase](http://firebase.com) with React Native straight-forward.
```
npm i react-native-firebase --save
```
[![Gitter](https://badges.gitter.im/invertase/react-native-firebase.svg)](https://gitter.im/invertase/react-native-firebase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Gitter](https://badges.gitter.im/invertase/react-native-firebase.svg)](https://gitter.im/invertase/react-native-firebase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![npm version](https://img.shields.io/npm/v/react-native-firebase.svg)](https://www.npmjs.com/package/react-native-firebase) [![npm version](https://img.shields.io/npm/v/react-native-firebase.svg)](https://www.npmjs.com/package/react-native-firebase)
[![License](https://img.shields.io/npm/l/react-native-firebase.svg)](/LICENSE) [![License](https://img.shields.io/npm/l/react-native-firebase.svg)](/LICENSE)
RNFirebase is a _light-weight_ layer sitting on-top of the native Firebase libraries for both iOS and Android which mirrors the Firebase Web SDK as closely as possible. **RNFirebase** makes using [Firebase](http://firebase.com) with React Native simple.
<hr>
### Install
```
npm i react-native-firebase --save
```
#### Platform specific setup guides:
* [ios](docs/installation.ios.md)
* [android](docs/installation.android.md)
## RNFirebase vs Firebase Web SDK ## RNFirebase vs Firebase Web SDK
RNFirebase is a _light-weight_ layer sitting on-top of the native Firebase libraries for both iOS and Android which mirrors the Firebase Web SDK as closely as possible.
Although the [Firebase Web SDK](https://www.npmjs.com/package/firebase) library will work with React Native, it is built for the web. Although the [Firebase Web SDK](https://www.npmjs.com/package/firebase) library will work with React Native, it is built for the web.
RNFirebase provides a JavaScript bridge to the native Firebase SDKs for both iOS and Android. The Firebase processes will run on the native thread, allowing the rest of your app to run on the [JS thread](https://facebook.github.io/react-native/docs/performance.html#javascript-frame-rate). The Firebase Web SDK also runs on the JS thread, therefore potentially affecting the frame rate causing jank with animations, touch events etc. All in, RNFirebase provides much faster performance (~2x) over the web SDK. RNFirebase provides a JavaScript bridge to the native Firebase SDKs for both iOS and Android. The Firebase processes will run on the native thread, allowing the rest of your app to run on the [JS thread](https://facebook.github.io/react-native/docs/performance.html#javascript-frame-rate). The Firebase Web SDK also runs on the JS thread, therefore potentially affecting the frame rate causing jank with animations, touch events etc. All in, RNFirebase provides much faster performance (~2x) over the web SDK.
@ -34,9 +40,6 @@ RNFirebase aims to replicate the Firebase Web SDK as closely as possible. Becaus
> If you find any discrepancies between the two libraries, please raise an issue or PR. > If you find any discrepancies between the two libraries, please raise an issue or PR.
* Installation
* [iOS](docs/installation.ios.md)
* [Android](docs/installation.android.md)
* [Firebase Setup](docs/firebase-setup.md) * [Firebase Setup](docs/firebase-setup.md)
* API * API
* [Authentication](docs/api/authentication.md) * [Authentication](docs/api/authentication.md)