diff --git a/README.md b/README.md index ef1f542b..2cfa1e02 100644 --- a/README.md +++ b/README.md @@ -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. -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! @@ -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. -| Firebase Features | v1 | [v2](https://github.com/invertase/react-native-firebase/pull/130) | Web SDK | +| Firebase Features | v1 | v2 | Web SDK | | ---------------------- | :---: | :---: | :---: | | AdMob | ❌ | ✅ | ❌ | | Analytics             | ✅ | ✅ | ❌ | @@ -59,13 +59,18 @@ All in all, RNFirebase provides much faster performance (~2x) over the web SDK a | 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 iOS SDK | 3.15.0+ | 4.0.0 + | diff --git a/android/src/main/java/io/invertase/firebase/RNFirebasePackage.java b/android/src/main/java/io/invertase/firebase/RNFirebasePackage.java index 349e7e22..b960b9c6 100644 --- a/android/src/main/java/io/invertase/firebase/RNFirebasePackage.java +++ b/android/src/main/java/io/invertase/firebase/RNFirebasePackage.java @@ -38,7 +38,7 @@ public class RNFirebasePackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/admob/RNFirebaseAdMobPackage.java b/android/src/main/java/io/invertase/firebase/admob/RNFirebaseAdMobPackage.java index cbb63600..6715affc 100644 --- a/android/src/main/java/io/invertase/firebase/admob/RNFirebaseAdMobPackage.java +++ b/android/src/main/java/io/invertase/firebase/admob/RNFirebaseAdMobPackage.java @@ -36,7 +36,7 @@ public class RNFirebaseAdMobPackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/analytics/RNFirebaseAnalyticsPackage.java b/android/src/main/java/io/invertase/firebase/analytics/RNFirebaseAnalyticsPackage.java index 9d15ea33..c1526610 100644 --- a/android/src/main/java/io/invertase/firebase/analytics/RNFirebaseAnalyticsPackage.java +++ b/android/src/main/java/io/invertase/firebase/analytics/RNFirebaseAnalyticsPackage.java @@ -35,7 +35,7 @@ public class RNFirebaseAnalyticsPackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/auth/RNFirebaseAuthPackage.java b/android/src/main/java/io/invertase/firebase/auth/RNFirebaseAuthPackage.java index 4e5c79d4..0fa905dc 100644 --- a/android/src/main/java/io/invertase/firebase/auth/RNFirebaseAuthPackage.java +++ b/android/src/main/java/io/invertase/firebase/auth/RNFirebaseAuthPackage.java @@ -35,7 +35,7 @@ public class RNFirebaseAuthPackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/config/RNFirebaseRemoteConfigPackage.java b/android/src/main/java/io/invertase/firebase/config/RNFirebaseRemoteConfigPackage.java index 57dd2350..e794313c 100644 --- a/android/src/main/java/io/invertase/firebase/config/RNFirebaseRemoteConfigPackage.java +++ b/android/src/main/java/io/invertase/firebase/config/RNFirebaseRemoteConfigPackage.java @@ -35,7 +35,7 @@ public class RNFirebaseRemoteConfigPackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/crash/RNFirebaseCrashPackage.java b/android/src/main/java/io/invertase/firebase/crash/RNFirebaseCrashPackage.java index 898e551b..8eeb6174 100644 --- a/android/src/main/java/io/invertase/firebase/crash/RNFirebaseCrashPackage.java +++ b/android/src/main/java/io/invertase/firebase/crash/RNFirebaseCrashPackage.java @@ -35,7 +35,7 @@ public class RNFirebaseCrashPackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/database/RNFirebaseDatabasePackage.java b/android/src/main/java/io/invertase/firebase/database/RNFirebaseDatabasePackage.java index 3eff31fc..7045aa53 100644 --- a/android/src/main/java/io/invertase/firebase/database/RNFirebaseDatabasePackage.java +++ b/android/src/main/java/io/invertase/firebase/database/RNFirebaseDatabasePackage.java @@ -35,7 +35,7 @@ public class RNFirebaseDatabasePackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/messaging/RNFirebaseMessagingPackage.java b/android/src/main/java/io/invertase/firebase/messaging/RNFirebaseMessagingPackage.java index a041740f..70ac5c94 100644 --- a/android/src/main/java/io/invertase/firebase/messaging/RNFirebaseMessagingPackage.java +++ b/android/src/main/java/io/invertase/firebase/messaging/RNFirebaseMessagingPackage.java @@ -35,7 +35,7 @@ public class RNFirebaseMessagingPackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/perf/RNFirebasePerformancePackage.java b/android/src/main/java/io/invertase/firebase/perf/RNFirebasePerformancePackage.java index 127af847..04e52835 100644 --- a/android/src/main/java/io/invertase/firebase/perf/RNFirebasePerformancePackage.java +++ b/android/src/main/java/io/invertase/firebase/perf/RNFirebasePerformancePackage.java @@ -35,7 +35,7 @@ public class RNFirebasePerformancePackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/android/src/main/java/io/invertase/firebase/storage/RNFirebaseStoragePackage.java b/android/src/main/java/io/invertase/firebase/storage/RNFirebaseStoragePackage.java index 5e19d782..b2668c6f 100644 --- a/android/src/main/java/io/invertase/firebase/storage/RNFirebaseStoragePackage.java +++ b/android/src/main/java/io/invertase/firebase/storage/RNFirebaseStoragePackage.java @@ -35,7 +35,7 @@ public class RNFirebaseStoragePackage implements ReactPackage { * listed here. Also listing a native module here doesn't imply that the JS implementation of it * will be automatically included in the JS bundle. */ - @Override + // TODO: Removed in 0.47.0. Here for backwards compatability public List> createJSModules() { return Collections.emptyList(); } diff --git a/docs/README.md b/docs/README.md index 22e88937..04461f31 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,7 +21,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. -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! @@ -32,30 +32,35 @@ All in all, RNFirebase provides much faster performance (~2x) over the web SDK a ## Supported Firebase Features > The Web SDK column indicates what modules from the Firebase Web SDK are usable within React Native. -| Firebase Features | v1 | [v2](https://github.com/invertase/react-native-firebase/pull/130) | Web SDK | +| Firebase Features | v1 | v2 | Web SDK | | ---------------------- | :---: | :---: | :---: | | AdMob | ❌ | ✅ | ❌ | | Analytics             | ✅ | ✅ | ❌ | | App Indexing           | ❌ | ❌ | ❌ | | Authentication | ✅ | ✅ | ✅ | -| Cloud Messaging | ✅ | ✅ | ❌ | +| Cloud Messaging (FCM) | ✅ | ✅ | ❌ | | Crash Reporting | ✅ | ✅ | ❌ | | Dynamic Links | ❌ | ❌ | ❌ | | Invites | ❌ | ❌ | ❌ | | Performance Monitoring | ✅ | ✅ | ❌ | | Realtime Database | ✅ | ✅ | ✅ | -| - Offline Persistance | ✅ | ✅ | ❌ | +| - Offline Persistence | ✅ | ✅ | ❌ | | - Transactions | ✅ | ✅ | ✅ | | Remote Config | ✅ | ✅ | ❌ | | 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 iOS SDK | 3.15.0+ | 4.0.0 + | diff --git a/docs/installation-ios.md b/docs/installation-ios.md index f2886f70..16e77cc3 100644 --- a/docs/installation-ios.md +++ b/docs/installation-ios.md @@ -70,7 +70,7 @@ pod 'Firebase/RemoteConfig' pod 'Firebase/Storage' ``` -If you are new to Cocoapods or do not already have React installed as a pod, then add Yoga and React to your `Podfile` as follows: +If you do not already have React and Yoga installed as pods, then add Yoga and React to your `Podfile` as follows: ```ruby pod "Yoga", :path => "../node_modules/react-native/ReactCommon/yoga" diff --git a/package.json b/package.json index 78d6a20b..1c40b52c 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "react-native-firebase", - "version": "2.0.5", + "version": "2.1.0", "author": "Invertase (http://invertase.io)", - "description": "A well tested, feature rich Firebase implementation for React Native, supporting iOS & Android. Individual module support for Auth, Database, Messaging, Remote Config, Storage, Admob, Analytics, Crash Reporting, and Performance.", + "description": "A well tested, feature rich Firebase implementation for React Native, supporting iOS & Android. Individual module support for Auth, Database, Messaging (FCM), Remote Config, Storage, Admob, Analytics, Crash Reporting, and Performance.", "main": "index", "scripts": { "build": "./node_modules/.bin/babel --source-maps=true --out-dir=dist .",