Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chemerisuk committed May 19, 2019
1 parent c51b9f0 commit 09bc558
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,39 @@
# cordova-plugin-firebase-analytics<br>[![NPM version][npm-version]][npm-url] [![NPM downloads][npm-downloads]][npm-url] [![Twitter][twitter-follow]][twitter-url]
> Cordova plugin for [Firebase Analytics](https://firebase.google.com/docs/analytics/)
# Cordova plugin for [Firebase Analytics](https://firebase.google.com/docs/analytics/)

## Installation
[![NPM version][npm-version]][npm-url] [![NPM downloads][npm-downloads]][npm-url] [![Twitter][twitter-follow]][twitter-url]

cordova plugin add cordova-plugin-firebase-analytics --save
| [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)][donate-url] | Your support is appreciated. Create a PR, submit a bug or just grab me :beer: |
|-|-|

Plugin depends on [cordova-support-google-services](https://github.com/chemerisuk/cordova-support-google-services) for setting up google services properly. Please read the [README](https://github.com/chemerisuk/cordova-support-google-services/blob/master/README.md) carefully in order to avoid common issues with a project configuration.
## Index

Use variable `FIREBASE_CORE_VERSION` to override dependency version on Android.
<!-- MarkdownTOC levels="2" autolink="true" -->

NOTE: on iOS in order to collect demographic, age, gender data etc. you should additionally [include `AdSupport.framework`](https://firebase.google.com/support/guides/analytics-adsupport) into your project.
- [Supported platforms](#supported-platforms)
- [Installation](#installation)
- [Methods](#methods)

## Supported Platforms
<!-- /MarkdownTOC -->

## Supported platforms

- iOS
- Android

## Installation

$ cordova plugin add cordova-plugin-firebase-analytics

If you get an error about CocoaPods being unable to find compatible versions, run

$ pod repo update

Plugin depends on [cordova-support-google-services](https://github.com/chemerisuk/cordova-support-google-services) for setting up google services properly. Please read the [README](https://github.com/chemerisuk/cordova-support-google-services/blob/master/README.md) carefully in order to avoid common issues with a project configuration.

Use variable `FIREBASE_CORE_VERSION` to override dependency version on Android.

NOTE: on iOS in order to collect demographic, age, gender data etc. you should additionally [include `AdSupport.framework`](https://firebase.google.com/support/guides/analytics-adsupport) into your project.

## Methods
Every method returns a promise that fulfills when a call was successful.

Expand Down Expand Up @@ -65,3 +83,4 @@ cordova.plugins.firebase.analytics.resetAnalyticsData();
[npm-downloads]: https://img.shields.io/npm/dm/cordova-plugin-firebase-analytics.svg
[twitter-url]: https://twitter.com/chemerisuk
[twitter-follow]: https://img.shields.io/twitter/follow/chemerisuk.svg?style=social&label=Follow%20me
[donate-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4SVTMPKTAD9QC&source=url

0 comments on commit 09bc558

Please sign in to comment.