From e78c288b40910260952194e79376b50782eb8468 Mon Sep 17 00:00:00 2001 From: Michael Diarmid Date: Thu, 23 Mar 2017 17:05:28 +0000 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 258f5d5e..a39fd7bf 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ -# React Native Firebase - -RNFirebase makes using the latest [Firebase](http://firebase.com) with React Native straight-forward. - -``` -npm i react-native-firebase --save -``` +# React Native Firebase [![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) [![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. +
+ +### 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 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. 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. -* Installation - * [iOS](docs/installation.ios.md) - * [Android](docs/installation.android.md) * [Firebase Setup](docs/firebase-setup.md) * API * [Authentication](docs/api/authentication.md)