Skip to content

Commit 90934cc

Browse files
authored
chore(firebase-core): README update (#184)
* chore(firebase-core): README update * chore: update
1 parent ab61707 commit 90934cc

File tree

1 file changed

+42
-7
lines changed

1 file changed

+42
-7
lines changed

packages/firebase-core/README.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,60 @@
11
# @nativescript/firebase-core
22

3+
A plugin to initialize [FirebaseApp](https://firebase.google.com/docs/reference/android/com/google/firebase/FirebaseApp) in your app.
4+
It should be used with any of:
5+
6+
- [@nativescript/firebase-admob](../firebase-admob/)
7+
- [@nativescript/firebase-analytics](../firebase-admob/)
8+
- [@nativescript/firebase-app-check](../firebase-app-check/)
9+
- [@nativescript/firebase-app-check-debug](../firebase-app-check-debug/)
10+
- [@nativescript/firebase-auth](../firebase-auth/)
11+
- [@nativescript/firebase-crashlytics](../firebase-analytics/)
12+
- [@nativescript/firebase-database](../firebase-database/)
13+
- [@nativescript/firebase-dynamic-links](../firebase-dynamic-links/)
14+
- [@nativescript/firebase-firestore](../firebase-firestore/)
15+
- [@nativescript/firebase-functions](../firebase-functions/)
16+
- [@nativescript/firebase-in-app-messaging](../firebase-in-app-messaging/)
17+
- [@nativescript/firebase-installations](../firebase-installations/)
18+
- [@nativescript/firebase-messaging](../firebase-messaging/)
19+
- [@nativescript/firebase-messaging-core](../firebase-messaging-core/)
20+
- [@nativescript/firebase-performance](../firebase-performance/)
21+
- [@nativescript/firebase-remote-config](../firebase-remote-config/)
22+
- [@nativescript/firebase-storage](../firebase-storage/)
23+
24+
## Installation
25+
326
```cli
427
npm install @nativescript/firebase-core
528
```
29+
## Configure Firebase for Android
30+
31+
To configure Firebase for Android, visit [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup) and follow the steps below.
32+
33+
- [Create a Firebase project](https://firebase.google.com/docs/android/setup#create-firebase-project)
34+
35+
- [Register your app with Firebase](https://firebase.google.com/docs/android/setup#register-app)
36+
37+
- [Add a Firebase configuration file](https://firebase.google.com/docs/android/setup#add-config-file) : Download the `google-services.json` file and add it to `App_Resources/Android/src`.
638

7-
## Usage
39+
## Configure Firebase for iOS
840

9-
### Android
10-
Ensure `google-services.json` file located in `App_Resources/Android/src`.
41+
To set up Firebase for iOS, visit [Add Firebase to your Apple project](https://firebase.google.com/docs/ios/setup) and follow the steps below:
42+
- [Create a Firebase project](https://firebase.google.com/docs/ios/setup#create-firebase-project)
43+
- [Register your app with Firebase](https://firebase.google.com/docs/ios/setup#register-app)
44+
- [Add a Firebase configuration file](https://firebase.google.com/docs/ios/setup#add-config-file): Download the `GoogleService-Info.plist` file and add it to `App_Resources/iOS/`.
1145

12-
### iOS
13-
Ensure `GoogleService-Info.plist` file located in `App_Resources/iOS`.
46+
## Use @nativescript/firebase-core
1447

15-
### Initialize Default App
48+
### Instantiate Firebase and initialize a default app
1649

50+
Import the `firebase` function and call it to create a NativeScript Firebase instance. Next, call the `initializeApp` method on the Firebase instance to instantiate the native [FirebaseApp](https://firebase.google.com/docs/reference/android/com/google/firebase/FirebaseApp).
51+
1752
```ts
1853
import { firebase } from '@nativescript/firebase-core'
1954
const defaultApp = await firebase().initializeApp();
2055
```
2156

22-
### Initialize Secondary App
57+
#### Initialize Secondary App
2358

2459
```ts
2560
import { firebase, FirebaseOptions } from '@nativescript/firebase-core'

0 commit comments

Comments
 (0)