[docs] Update main readme with supported versions

This commit is contained in:
Chris Bianca 2017-08-03 08:57:19 +01:00
parent d304952ce3
commit 0154c0ce36
1 changed files with 11 additions and 6 deletions

View File

@ -30,7 +30,7 @@ RNFirebase is a _light-weight_ layer sitting on-top of the native Firebase libra
Although the [Firebase Web SDK](https://www.npmjs.com/package/firebase) library will work with React Native, it is mainly built for the web. Although the [Firebase Web SDK](https://www.npmjs.com/package/firebase) library will work with React Native, it is mainly built for the web.
RNFirebase provides a JavaScript bridge to the native Firebase SDKs for both iOS and Android therefore Firebase 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. RNFirebase provides a JavaScript bridge to the native Firebase SDKs for both iOS and Android therefore Firebase 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.
The native SDKs also allow us to hook into device sdk's which are not possible with the web SDK, for example crash reporting, offline realtime database support, analyics and more! The native SDKs also allow us to hook into device sdk's which are not possible with the web SDK, for example crash reporting, offline realtime database support, analyics and more!
@ -41,7 +41,7 @@ All in all, RNFirebase provides much faster performance (~2x) over the web SDK a
> The Web SDK column indicates what modules from the Firebase Web SDK are usable with React Native. > The Web SDK column indicates what modules from the Firebase Web SDK are usable with React Native.
| Firebase Features | v1 | [v2](https://github.com/invertase/react-native-firebase/pull/130) | Web SDK | | Firebase Features | v1 | v2 | Web SDK |
| ---------------------- | :---: | :---: | :---: | | ---------------------- | :---: | :---: | :---: |
| AdMob | ❌ | ✅ | ❌ | | AdMob | ❌ | ✅ | ❌ |
| Analytics             | ✅ | ✅ | ❌ | | Analytics             | ✅ | ✅ | ❌ |
@ -59,13 +59,18 @@ All in all, RNFirebase provides much faster performance (~2x) over the web SDK a
| Storage | ✅ | ✅ | ❌ | | Storage | ✅ | ✅ | ❌ |
--- ---
### Supported versions - Firebase / React Native ### Supported versions - React Native / Firebase
> The table below shows the minimum supported versions of the Firebase SDKs and React Native > The table below shows the supported version of `react-native-firebase` for different React Native versions
| | v1 | [v2](https://github.com/invertase/react-native-firebase/pull/130) | | v0.36 - v0.39 | v0.40 - v0.46 | v0.47 +
| ------------------------------- | :---: | :---: | :---: |
| react-native-firebase | 1.X.X | 2.X.X | 2.1.X |
> The table below shows the minimum supported versions of the Firebase SDKs for each version of `react-native-firebase`
| | v1 | v2 |
| ---------------------- | :---: | :---: | | ---------------------- | :---: | :---: |
| React Native | 0.36.0+ | 0.40.0 + |
| Firebase Android SDK | 10.2.0+ | 11.0.0 + | | Firebase Android SDK | 10.2.0+ | 11.0.0 + |
| Firebase iOS SDK | 3.15.0+ | 4.0.0 + | | Firebase iOS SDK | 3.15.0+ | 4.0.0 + |