ProtonMail
/
proton-mail-android
mirror of https://github.com/ProtonMail/proton-mail-android
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md to include disclaimer about missing push notifications / FCM 

MAILAND-1027
This commit is contained in:
Delong Lu 2020-10-21 10:25:38 +00:00 committed by stefanija
parent ae1f74ac45
commit 91343de5a4
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,4 +1,3 @@
# ProtonMail for Android
Copyright (c) 2020 Proton Technologies AG
@ -30,6 +29,14 @@ Then, go to the app’s root directory in the command line tool and run:
- `./gradlew assembleBetaDebug`
- `adb install ./app/build/outputs/apk/beta/debug/ProtonMail-Android-1.XX.X-beta-debug.apk`
### Note: In app notifications when building from source
**When building from source, in app push notifications for new emails will not work out of the box.**
The app uses Google's Firebase Cloud Messaging (FCM) service to deliver push notifications. However, we are not publishing the production version of the configuration files needed to set up this service, because the values specified within are deemed sensitive.
Instead, we publish dummy versions of the files (`config/google-services/dummy-google-services.json` and `config/google-services/dummy-google-services-beta.json`) which allows you to build the app without push notifications. The dummy files will be copied to the relevant folders once you run the ./gradlew command.
We may offer alternative push notification systems in the future which do not rely on Google services.
## Contributions
Contributions are appreciated, but must conform to Proton Guidelines.