From af7502e19954eaaf33302fb8c871adbe8209d4f3 Mon Sep 17 00:00:00 2001 From: Elliot Hesp Date: Thu, 27 Apr 2017 12:25:29 +0100 Subject: [PATCH] Cleanup main README --- README.md | 47 ++++------------------------------------------- docs/README.md | 5 +++++ 2 files changed, 9 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index e04793aa..61aec0d2 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,15 @@ **RNFirebase** makes using [Firebase](http://firebase.com) with React Native simple.
+> [Documentation](https://invertase.io/react-native-firebase) + ### Install -``` +```bash npm i react-native-firebase --save ``` #### Platform specific setup guides: -[![ios](https://a.fsdn.com/sd/topics/ios_64.png)](docs/installation.ios.md) [![android](https://a.fsdn.com/sd/topics/android_64.png)](docs/installation.android.md) +[![ios](https://a.fsdn.com/sd/topics/ios_64.png)](http://invertase.io/react-native-firebase/#/installation-ios) [![android](https://a.fsdn.com/sd/topics/android_64.png)](http://invertase.io/react-native-firebase/#/installation-android)
@@ -30,47 +32,6 @@ The native SDKs also allow us to hook into device sdk's which are not possible w
-### Test app - -To help ensure changes and features work across both iOS & Android, we've developed an app specifically to test `react-native-firebase` against the [`firebase` web SDK](https://www.npmjs.com/package/firebase). Please see the [`tests`](tests/README.md) directory for more information. - -
- -### Examples app - -There's currently a work in progress [examples app](https://github.com/invertase/react-native-firebase-examples) which aims to demonstrate various real world use-case scenarios with React Native & Firebase. We welcome any new examples or updates to existing ones. - -
- -### Documentation - -RNFirebase aims to replicate the Firebase Web SDK as closely as possible. Because of this, the documentation focuses around the installation, differences & best practices of this library. Please see the [Firebase Web SDK](https://firebase.google.com/docs/reference/js/) documentation for Firebase functionality. - -> If you find any discrepancies between the two libraries, please raise an issue or PR. - -* [Firebase Setup](docs/firebase-setup.md) -* API - * [Authentication](docs/api/authentication.md) - * [Realtime Database](docs/api/database.md) - * [Analytics](docs/api/analytics.md) - * [Storage](docs/api/storage.md) - * [Messaging](docs/api/cloud-messaging.md) - * [Crash](docs/api/crash.md) - * [Transactions](docs/api/transactions.md) -* [FAQs / Troubleshooting](docs/faqs.md) - -
- -### Contributing - -We welcome any contribution to the repository. Please ensure your changes to the JavaScript code follow the styling guides controlled by ESlint. Changes to native code should be kept clean and follow the standard of existing code. - -Changes to existing code should ensure all relevant tests on the test app pass. Any new features should have new tests created and ensure all existing tests pass. - -**Project board:** https://github.com/invertase/react-native-firebase/projects - -
- ### License - MIT diff --git a/docs/README.md b/docs/README.md index f45bd754..a2c60da3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,6 +6,11 @@
+[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/t6bdqMs) +[![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) +
A well tested Firebase implementation for React Native, supporting both iOS & Android apps.