Skip to content

Commit ebf3191

Browse files
committed
Updating README.
1 parent dcfd859 commit ebf3191

File tree

1 file changed

+31
-23
lines changed

1 file changed

+31
-23
lines changed

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,25 @@ This plugin brings push notifications, analytics, event tracking, crash reportin
99
<!-- toc -->
1010

1111
- [Difference from the fork repository](#difference-from-the-fork-repository)
12-
* [Confirm your Cordova environment versions](#confirm-your-cordova-environment-versions)
12+
- [Confirm your Cordova environment versions](#confirm-your-cordova-environment-versions)
1313
- [Major Releases](#major-releases)
1414
* [v5.x](#v5x)
1515
+ [Supported Cordova Platforms](#supported-cordova-platforms)
1616
* [v4.x](#v4x)
1717
+ [Supported Cordova Platforms](#supported-cordova-platforms-1)
1818
* [v3.x](#v3x)
1919
+ [Supported Cordova Platforms](#supported-cordova-platforms-2)
20-
- [Installation](#installation)
20+
- [Installation & Setup](#installation--setup)
2121
* [Uninstall the original firebase plugin](#uninstall-the-original-firebase-plugin)
22-
* [For `cordova-cli >= 9.x.x` && (`cordava-ios >= 5.0.1` || `cordava-android >= 8.x.x`)](#for-cordova-cli--9xx--cordava-ios--501--cordava-android--8xx)
23-
* [For `cordova-cli = 4.5.0` || `cordova-android >= 8.x.x`)](#for-cordova-cli--450--cordova-android--8xx)
24-
* [For `cordova-cli <= 7.1.0` && (`cordava-ios <= 4.5.5` || `cordova-android <= 7.1.4`)](#for-cordova-cli--710--cordava-ios--455--cordova-android--714)
22+
* [Install this plugin](#install-this-plugin)
2523
* [AndroidX](#androidx)
26-
- [Guides](#guides)
24+
* [Guides](#guides)
2725
* [Setup](#setup)
28-
* [IMPORTANT NOTES](#important-notes)
26+
* [Important Notes](#important-notes)
2927
* [PhoneGap Build](#phonegap-build)
3028
* [Google Play Services](#google-play-services)
3129
- [Docs](#docs)
32-
* [API](#api)
30+
* [API Docs](#api-docs)
3331
* [Google Tag Manager](#google-tag-manager)
3432
* [Configuring Notifications](#configuring-notifications)
3533

@@ -45,7 +43,7 @@ application. To see a full list of changes done after we started maintaining thi
4543
[Releases](https://github.com/wizpanda/cordova-plugin-firebase-lib/releases) or read the
4644
[CHANGELOG.md](https://github.com/wizpanda/cordova-plugin-firebase-lib/blob/master/CHANGELOG.md#v300)
4745

48-
### Confirm your Cordova environment versions
46+
## Confirm your Cordova environment versions
4947

5048
Before you continue installing this plugin, please confirm your Cordova environment versions. You can either get everything by just
5149
running:
@@ -101,7 +99,7 @@ which was released before Jun 17, 2019.
10199
- cordova-android: `>= 7.0.0` (Might work on `cordova-android 6.x` versions)
102100
- cordova-ios: `>= 4.5.5` (Might work on old `cordova-ios` versions)
103101

104-
## Installation
102+
## Installation & Setup
105103

106104
### Uninstall the original firebase plugin
107105

@@ -112,23 +110,25 @@ rm -rf platforms/android
112110
cordova plugin remove cordova-plugin-firebase
113111
```
114112

115-
### For `cordova-cli >= 9.x.x` && (`cordava-ios >= 5.0.1` || `cordava-android >= 8.x.x`)
113+
### Install this plugin
114+
115+
**For `cordova-cli >= 9.x.x` && (`cordava-ios >= 5.0.1` || `cordava-android >= 8.x.x`)**
116116

117117
Use the latest major releases just by running:
118118

119119
```bash
120-
cordova plugin add cordova-plugin-firebase-lib --save
120+
cordova plugin add cordova-plugin-firebase-lib
121121
```
122122

123-
### For `cordova-cli <= 8.1.1` && (`cordava-ios >= 4.5.0` || `cordova-android >= 8.x.x`)
123+
**For `cordova-cli <= 8.1.1` && (`cordava-ios <= 4.5.5` || `cordova-android >= 8.x.x`)**
124124

125125
Use the v4.x release by running:
126126

127127
```bash
128128
cordova plugin add [email protected] --save
129129
```
130130

131-
### For `cordova-cli <= 7.1.0` && (`cordava-ios <= 4.5.5` || `cordova-android <= 7.1.4`)
131+
**For `cordova-cli <= 7.1.0` && (`cordava-ios <= 4.5.5` || `cordova-android <= 7.1.4`)**
132132

133133
Run the following in your terminal:
134134

@@ -150,18 +150,18 @@ cordova plugin add cordova-plugin-androidx
150150
cordova plugin add cordova-plugin-androidx-adapter
151151
```
152152

153-
## Guides
153+
### Guides
154154

155155
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)
156156

157157
### Setup
158158

159159
Download your Firebase configuration files:
160160

161-
* `GoogleService-Info.plist` for iOS and
162-
* `google-services.json` for Android
161+
- `GoogleService-Info.plist` for iOS and
162+
- `google-services.json` for Android
163163

164-
And place them in the root folder of your cordova project. Check out this [firebase article](https://support.google.com/firebase/answer/7015592)
164+
And place them in the root folder of your Cordova app. Check out this [firebase article](https://support.google.com/firebase/answer/7015592)
165165
for details on how to download the files.
166166

167167
```bash
@@ -175,22 +175,30 @@ for details on how to download the files.
175175
...
176176
```
177177

178-
###### IMPORTANT NOTES
178+
### Important Notes
179+
179180
- This plugin uses a hook (after prepare) that copies the configuration files to the right place, namely
180181
`platforms/ios/my-cordova-project/Resources` for iOS and `platforms/android` for Android.
181182
- Firebase SDK requires the configuration files to be present and valid, otherwise your app will crash on boot or Firebase features won't work.
182183

183184
### PhoneGap Build
184-
Hooks do not work with PhoneGap Build. This means you will have to manually make sure the configuration files are included. One way to do that is to make a private fork of this plugin and replace the placeholder config files (see `src/ios` and `src/android`) with your actual ones, as well as hard coding your app id and api key in `plugin.xml`.
185+
186+
Hooks do not work with PhoneGap Build. This means you will have to manually make sure the configuration files are included. One way to do
187+
that is to make a private fork of this plugin and replace the placeholder config files (see `src/ios` and `src/android`) with your
188+
actual ones, as well as hard coding your app id and api key in `plugin.xml`.
185189

186190
### Google Play Services
187-
Your build may fail if you are installing multiple plugins that use Google Play Services. This is caused by the plugins installing different versions of the Google Play Services library. This can be resolved by installing [cordova-android-play-services-gradle-release](https://github.com/dpa99c/cordova-android-play-services-gradle-release).
191+
Your build may fail if you are installing multiple plugins that use Google Play Services. This is caused by the plugins installing
192+
different versions of the Google Play Services library. This can be resolved by installing
193+
[cordova-android-play-services-gradle-release](https://github.com/dpa99c/cordova-android-play-services-gradle-release).
188194

189-
If your build is still failing, you can try installing [cordova-android-firebase-gradle-release](https://github.com/dpa99c/cordova-android-firebase-gradle-release). For more info, read the following [comment](https://github.com/dpa99c/cordova-plugin-request-location-accuracy/issues/50#issuecomment-390025013) about locking down the specific versions for play services and firebase. It is suggested to use `+` instead of `15.+` to ensure the correct versions are used.
195+
If your build is still failing, you can try installing [cordova-android-firebase-gradle-release](https://github.com/dpa99c/cordova-android-firebase-gradle-release).
196+
For more info, read the following [comment](https://github.com/dpa99c/cordova-plugin-request-location-accuracy/issues/50#issuecomment-390025013)
197+
about locking down the specific versions for play services and firebase. It is suggested to use `+` instead of `15.+` to ensure the correct versions are used.
190198

191199
## Docs
192200

193-
### API
201+
### API Docs
194202

195203
See the full [API](docs/API.md) docs available for this plugin.
196204

0 commit comments

Comments
 (0)