Skip to content

Commit 8846a8c

Browse files
committed
Moving the difference doc on the top & some cleanup.
1 parent 645d5f3 commit 8846a8c

File tree

1 file changed

+15
-24
lines changed

1 file changed

+15
-24
lines changed

README.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cordova Firebase Plugin2
1+
# Cordova Firebase Plugin
22

33
[![npm version](https://badge.fury.io/js/cordova-plugin-firebase-lib.svg)](https://badge.fury.io/js/cordova-plugin-firebase-lib)
44

@@ -8,18 +8,15 @@ This plugin brings push notifications, analytics, event tracking, crash reportin
88

99
<!-- toc -->
1010

11+
- [Difference from the fork repository](#difference-from-the-fork-repository)
1112
- [Prerequisites](#prerequisites)
1213
* [For Android App](#for-android-app)
1314
* [For iOS App](#for-ios-app)
14-
- [Difference from the fork repository](#difference-from-the-fork-repository)
1515
- [Confirm your Cordova environment versions](#confirm-your-cordova-environment-versions)
16-
- [Major Releases](#major-releases)
16+
- [Major Releases](#major-releases-and-supported-cordova-platforms)
1717
* [v5.x](#v5x)
18-
+ [Supported Cordova Platforms](#supported-cordova-platforms)
1918
* [v4.x](#v4x)
20-
+ [Supported Cordova Platforms](#supported-cordova-platforms-1)
2119
* [v3.x](#v3x)
22-
+ [Supported Cordova Platforms](#supported-cordova-platforms-2)
2320
- [Installation & Setup](#installation--setup)
2421
* [Uninstall the original firebase plugin](#uninstall-the-original-firebase-plugin)
2522
* [Install this plugin](#install-this-plugin)
@@ -37,6 +34,16 @@ This plugin brings push notifications, analytics, event tracking, crash reportin
3734

3835
<!-- tocstop -->
3936

37+
## Difference from the fork repository
38+
39+
Maintained by [Wiz Panda](https://www.wizpanda.com/).
40+
41+
The [author](https://github.com/arnesson) did a great job on the plugin. But seems not to be maintaining the changes. So we at **Wiz Panda**
42+
thought to maintain the repository with the latest changes & fixes so the others can take benefit of the Firebase in their cordova
43+
application. To see a full list of changes done after we started maintaining this fork, please see the
44+
[Releases](https://github.com/wizpanda/cordova-plugin-firebase-lib/releases) or read the
45+
[CHANGELOG.md](https://github.com/wizpanda/cordova-plugin-firebase-lib/blob/master/CHANGELOG.md#v300)
46+
4047
## Prerequisites
4148

4249
### For Android App
@@ -50,16 +57,6 @@ This plugin brings push notifications, analytics, event tracking, crash reportin
5057
2. CocoaPods 1.4.0 or later.
5158
3. Check more here at https://firebase.google.com/docs/ios/setup#prerequisites
5259

53-
## Difference from the fork repository
54-
55-
Maintained by [Wiz Panda](https://www.wizpanda.com/).
56-
57-
The [author](https://github.com/arnesson) did a great job on the plugin. But seems not to be maintaining the changes. So we at **Wiz Panda**
58-
thought to maintain the repository with the latest changes & fixes so the others can take benefit of the Firebase in their cordova
59-
application. To see a full list of changes done after we started maintaining this fork, please see the
60-
[Releases](https://github.com/wizpanda/cordova-plugin-firebase-lib/releases) or read the
61-
[CHANGELOG.md](https://github.com/wizpanda/cordova-plugin-firebase-lib/blob/master/CHANGELOG.md#v300)
62-
6360
## Confirm your Cordova environment versions
6461

6562
Before you continue installing this plugin, please confirm your Cordova environment versions. You can either get everything by just
@@ -75,7 +72,7 @@ Or grab it manually:
7572
2. For `cordova-android`, check the version in your `config.xml`. It should be like: `<engine name="android" spec="7.1.4" />`
7673
3. For `cordova-ios`, check the version in same `config.xml`. It should be like: `<engine name="ios" spec="4.5.5" />`
7774

78-
## Major Releases
75+
## Major Releases and Supported Cordova Platforms
7976

8077
In the last week from Jun 17, 2019 to Jun 25, 2019, we released three major versions of this plugin so that developers across the globe,
8178
who are using different versions of `cordova-lib`, `cordova-android` & `cordova-ios` can use different version of this plugin without
@@ -86,10 +83,8 @@ needing to upgrade these 3 dependencies immediately. So here are the three major
8683
1. CocoaPods is used to manage Firebase dependencies for iOS. We don't need `cordova-plugin-cocoapod-support` because `cordova-cli 9.x`
8784
has better support of handling CocoaPods dependencies.
8885

89-
#### Supported Cordova Platforms
90-
9186
- cordova-cli: `>= 9.0.0`
92-
- cordova-lib: `>= 9.0.0` (Will be used automatically by `cordova-cli`)
87+
- cordova-lib: `>= 9.0.1` (Will be used automatically by `cordova-cli`)
9388
- cordova-android: `>= 8.0.0`
9489
- cordova-ios: `>= 5.0.1`
9590

@@ -98,8 +93,6 @@ has better support of handling CocoaPods dependencies.
9893
1. Minimum `v8.0.0` of `cordova-android` is now required. View [#13](https://github.com/wizpanda/cordova-plugin-firebase-lib/pull/13) for details.
9994
2. Using latest versions of Firebase Android dependencies.
10095

101-
#### Supported Cordova Platforms
102-
10396
- cordova: `>= 8.0.0`
10497
- cordova-lib: `>= 8.0.0` (Will be used automatically by `cordova-cli`)
10598
- cordova-android: `>= 8.0.0`
@@ -110,8 +103,6 @@ has better support of handling CocoaPods dependencies.
110103
1. Using last [released](https://firebase.google.com/support/release-notes/android#update_-_may_31_2019) Firebase Android dependencies
111104
which was released before Jun 17, 2019.
112105

113-
#### Supported Cordova Platforms
114-
115106
- cordova: `>= 7.0.0`
116107
- cordova-android: `>= 7.0.0` (Might work on `cordova-android 6.x` versions)
117108
- cordova-ios: `>= 4.5.5` (Might work on old `cordova-ios` versions)

0 commit comments

Comments
 (0)