From 4ad06b767b5947afa323a199a2cc711ccdcb1bc1 Mon Sep 17 00:00:00 2001 From: Chris Bianca Date: Mon, 6 Nov 2017 13:42:50 +0000 Subject: [PATCH] [docs] Restructured Readme.md --- README.md | 90 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 47 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 3563c044..85a17c70 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,23 @@ -# React Native Firebase +

+ +
+

React Native Firebase

+ +

-[![Backers on Open Collective](https://opencollective.com/react-native-firebase/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/react-native-firebase/sponsors/badge.svg)](#sponsors) [![npm version](https://img.shields.io/npm/v/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase) -[![NPM downloads](https://img.shields.io/npm/dm/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase) -[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?style=flat-square)](https://discord.gg/t6bdqMs) -[![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg?style=flat-square)](https://www.patreon.com/invertase) -[![Twitter Follow](https://img.shields.io/twitter/follow/rnfirebase.svg?style=social&label=Follow)](https://twitter.com/rnfirebase) +

+ NPM downloads + NPM version + License + Backers on Open Collective + Sponsors on Open Collective + Chat + Follow on Twitter +

+## Introduction -**RNFirebase** makes using [Firebase](http://firebase.com) with React Native simple. - ---- - -We also support **both** databases: Realtime Database and Cloud Firestore! - ---- - - - - -
- -> [Docs](https://rnfirebase.io/) | [Starter App](https://github.com/invertase/react-native-firebase-starter) | [iOS Install Guide](https://rnfirebase.io/docs/v3.0.*/installation/ios) | [Android Install Guide](https://rnfirebase.io/docs/v3.0.*/installation/android) | [FAQs](https://rnfirebase.io/docs/v3.0.*/faqs) | [Feature Requests](http://invertase.link/requests) - -
- -### Install -```bash -npm i react-native-firebase --save -``` - -
- -### Why - -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. It 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 mainly built for the web. @@ -46,6 +28,7 @@ The native SDKs also allow us to hook into device sdk's which are not possible w All in all, RNFirebase provides much faster performance (~2x) over the web SDK and provides device sdk's not found in the web sdk (see the feature table below). --- + ## Supported Firebase Features > The Web SDK column indicates what modules/functionality from the Web SDK are usable within React Native. @@ -61,7 +44,7 @@ All in all, RNFirebase provides much faster performance (~2x) over the web SDK a | _-- Phone Auth_ | ❌ | ❌ | ✅ | ✅ | ❌ | | **Core** | ❌ |**?**| ✅ | ✅ | ✅ | | _-- Multiple Apps_ | ❌ | ❌ | ✅ | ✅ | ✅ | -| **Cloud Firestore** | ❌ | ❌ | ✅ | ✅ | ❌ | +| **Cloud Firestore** | ❌ | ❌ | ✅ | ✅ |**?**| | **Cloud Messaging (FCM)** | ✅ | ✅ | ✅ | ✅ |**?**| | **Crash Reporting** | ✅ | ✅ | ✅ | ✅ | ❌ | | **Dynamic Links** | ❌ | ❌ | ❌ | ✅ | ❌ | @@ -86,19 +69,42 @@ All in all, RNFirebase provides much faster performance (~2x) over the web SDK a --- -## Contributors +## Documentation + +To check out our latest docs, visit [rnfirebase.io](https://rnfirebase.io) + +## Questions + +For questions and support please use our [Discord chat](https://discord.gg/t6bdqMs) or [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-firebase). The issue list of this repo is **exclusively** for bug reports. + +## Issues + +Please make sure to complete the issue template before opening an issue. Issues not conforming to the guidelines may be closed immediately. + +## Feature Requests + +For feature requests please use our [Canny Board](http://invertase.link/requests). + +## Changelog + +Detailed changes for each release are documented in the [releases notes](https://github.com/invertase/react-native-firebase/releases). + +
+ +## Contribution + +Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request. + +Thank you to all the people who have already contributed to RNFirebase! -This project exists thanks to all the people who contribute. [[Contribute]](CONTRIBUTING.md). - ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/react-native-firebase#backer)] - ## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/react-native-firebase#sponsor)] @@ -114,8 +120,6 @@ Support this project by becoming a sponsor. Your logo will show up here with a l - - -### License +## License - See [LICENSE](/LICENSE)