docs(firebase): improve docs

This commit is contained in:
Ibby 2017-01-20 16:29:15 -05:00
parent 2f89ae0e84
commit 09747cd746

View File

@ -1,14 +1,21 @@
import { Plugin, Cordova } from './plugin'; import { Plugin, Cordova } from './plugin';
import { Observable } from 'rxjs/Observable' import { Observable } from 'rxjs/Observable';
/** /**
* @name Firebase * @name Firebase
* @description * @description
* This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10).
* *
* @usage * @usage
* ``` * ```
* import { Firebase } from 'ionic-native'; * import { Firebase } from 'ionic-native';
* *
* Firebase.getToken()
* .then(token => console.log(`The token is ${token}`)) // save the token server-side and use it to push notifications to this device
* .catch(error => console.error('Error getting token', error));
*
* Firebase.onTokenRefresh()
* .subscribe((token: string) => console.log(`Got a new token ${token}`));
* *
* ``` * ```
*/ */
@ -16,7 +23,8 @@ import { Observable } from 'rxjs/Observable'
pluginName: 'Firebase', pluginName: 'Firebase',
plugin: 'cordova-plugin-firebase', plugin: 'cordova-plugin-firebase',
pluginRef: 'FirebasePlugin', pluginRef: 'FirebasePlugin',
repo: 'https://github.com/arnesson/cordova-plugin-firebase' repo: 'https://github.com/arnesson/cordova-plugin-firebase',
platforms: ['Android', 'iOS']
}) })
export class Firebase { export class Firebase {