Update quick-start.md

This commit is contained in:
Elliot Hesp
2019-09-30 15:40:44 +01:00
committed by GitHub
parent 1570690086
commit 3902607ca5

View File

@@ -3,35 +3,8 @@ title: Quick Start
description: Getting started with Notifications in React Native Firebase
---
# Notifications Quick Start
# Notifications
> This module has not yet been migrated as part of the on-going v6 work.
Please note, the notifications module is not available at this current time.
## Installation
This module depends on the `@react-native-firebase/app` module. To get started and install `app`,
visit the project's <Anchor version={false} group={false} href="/quick-start">quick start</Anchor> guide.
Install this module with Yarn:
```bash
yarn add @react-native-firebase/notifications
```
> Integrating manually and not via React Native auto-linking? Check the setup instructions for <Anchor version group href="/android">Android</Anchor> & <Anchor version group href="/ios">iOS</Anchor>.
## Module usage
Import the Performance Monitoring package into your project:
```js
import notifications from '@react-native-firebase/notifications';
```
The package also provides access to the firebase instance:
```js
import { firebase } from '@react-native-firebase/notifications';
```
### TODO
Please see https://github.com/invertase/react-native-firebase/issues/2566 for more information.