Skip to content

Commit

Permalink
Updating README.
Browse files Browse the repository at this point in the history
  • Loading branch information
sagrawal31 committed Jun 25, 2019
1 parent 0d4719d commit 1e8a384
Showing 1 changed file with 42 additions and 10 deletions.
52 changes: 42 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ This plugin brings push notifications, analytics, event tracking, crash reportin

<!-- tocstop -->

## 4.0.0 - Breaking Change

Minimum `v8.0.0` of `cordova-android` is now required. View https://github.com/wizpanda/cordova-plugin-firebase-lib/pull/13 for details.

## Difference from the fork repository

Maintained by [Wiz Panda](https://www.wizpanda.com/).
Expand All @@ -41,6 +37,48 @@ thought to maintain the repository with the latest changes & fixes so the others
application. To see a full list of changes done after we started maintaining this fork, please see the [Releases](https://github
.com/wizpanda/cordova-plugin-firebase-lib/releases) or read the [CHANGELOG.md](https://github.com/wizpanda/cordova-plugin-firebase-lib/blob/master/CHANGELOG.md#v300)

## Major Releases

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,
who are using different versions of `cordova-lib`, `cordova-android` & `cordova-ios` can use different version of this plugin without
needing to upgrade these 3 dependencies immediately.

So here are the three major releases of this plugin:

### v5.x

1. CocoaPods is used to manage Firebase dependencies for iOS

#### Supported Cordova Platforms

- cordova-cli: `>= 9.0.0`
- cordova-lib: `>= 9.0.0` (Will be used automatically by `cordova-cli`)
- cordova-android: `>= 8.0.0`
- cordova-ios: `>= 5.0.1`

### v4.x

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.
2. Using latest versions of Firebase Android dependencies.

#### Supported Cordova Platforms

- cordova: `>= 8.0.0`
- cordova-lib: `>= 8.0.0` (Will be used automatically by `cordova-cli`)
- cordova-android: `>= 8.0.0`
- cordova-ios: `>= 4.5.5`

### v3.x

1. Using last [released](https://firebase.google.com/support/release-notes/android#update_-_may_31_2019) Firebase Android dependencies
which was released before Jun 17, 2019.

#### Supported Cordova Platforms

- cordova: `>= 7.0.0`
- cordova-android: `>= 7.0.0` (Might work on `cordova-android 6.x` versions)
- cordova-ios: `>= 4.5.5` (Might work on old `cordova-ios` versions)

## Installation

### Uninstall the original firebase plugin
Expand Down Expand Up @@ -91,12 +129,6 @@ cordova plugin add cordova-plugin-androidx
cordova plugin add cordova-plugin-androidx-adapter
```

## Supported Cordova Versions

- cordova: `>= 8`
- cordova-android: `>= 8.0.0`
- cordova-ios: `>= 4.5.5`

## Guides

1. Great installation and setup guide [https://medium.com/@felipepucinelli/how-to-add-push...](https://medium.com/@felipepucinelli/how-to-add-push-notifications-in-your-cordova-application-using-firebase-69fac067e821)
Expand Down

0 comments on commit 1e8a384

Please sign in to comment.