Skip to content

docs: Improve README #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 15, 2024
Merged

docs: Improve README #250

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d43ecc
Update README.md
mtrezza May 15, 2024
6b9a85d
Merge branch 'master' into docs/add-gcc-instructions
mtrezza May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The official Push Notification adapter for Parse Server. See [Parse Server Push
- [Configure Parse Server](#configure-parse-server)
- [Apple Push Options](#apple-push-options)
- [Android Push Options](#android-push-options)
- [Google Cloud Service Account Key](#google-cloud-service-account-key)
- [Migration to FCM HTTP v1 API (June 2024)](#migration-to-fcm-http-v1-api-june-2024)
- [Expo Push Options](#expo-push-options)
- [Bundled with Parse Server](#bundled-with-parse-server)
Expand Down Expand Up @@ -109,7 +110,9 @@ android: {
}
```

Alternatively, instead of setting `firebaseServiceAccount` to the path of the JSON file, you can provide an object representing a Google Cloud service account key:
#### Google Cloud Service Account Key

The Firebase console allows to easily create and download a Google Cloud service account key JSON file with the required permissions. Instead of setting `firebaseServiceAccount` to the path of the JSON file, you can provide an object representing a Google Cloud service account key:

```js
android: {
Expand All @@ -121,7 +124,7 @@ android: {
}
```

This can be helpful if you are already managing credentials to Google Cloud APIs in other parts of your code and you want to reuse these credentials, or if you want to manage credentials on a more granular level directly via Google Cloud.
This can be helpful if you are already managing credentials to Google Cloud APIs in other parts of your code and you want to reuse these credentials, or if you want to manage credentials on a more granular level directly in Google Cloud. Make sure that the service account has the permission `cloudmessaging.messages.create` which is for example part of role `Firebase Cloud Messaging API Admin`.

#### Migration to FCM HTTP v1 API (June 2024)

Expand Down
Loading