summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGuillaume Jacquart <guillaume.jacquart@hoodbrains.com>2023-01-12 07:45:52 +0000
committerGuillaume Jacquart <guillaume.jacquart@hoodbrains.com>2023-01-12 07:45:52 +0000
commit8fc2b39e12c247b16231f7421b8b9dcf863e24de (patch)
tree02261d62fe73fa07ba2ae9a413a075242c3379a6 /README.md
parent7cad75f498d1afbb69069b582bb75ebf7a8833aa (diff)
855: setup Sentry telemetry.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5cc125d..17d2c62 100644
--- a/README.md
+++ b/README.md
@@ -42,13 +42,14 @@ You can use any latest stable version of android studio to be able to build this
- Target SDK: 30 (Android R)
## API Keys
-This project uses [Mapbox](https://docs.mapbox.com/android/maps/guides/install/) sdk for displaying maps. To download and use the mapbox sdk, you need to supply API key and secret and set them as follows:
+This project uses [Sentry](https://sentry.io) for telemetry and crash reports, [Mapbox](https://docs.mapbox.com/android/maps/guides/install/) sdk for displaying maps. To download and use the mapbox sdk, you need to supply API key and secret and set them as follows:
### For local build
You can set them in local.properties
```
MAPBOX_KEY=<insert mapbox public key>
MAPBOX_SECRET_KEY=<insert mapbox secret key>
+SENTRY_DSN=<insert sentry dsn>
```
**IMP: Never add this file to version control.**
@@ -57,6 +58,7 @@ When building in CI environment, we don't have local.properties file. So the fol
```
export MAPBOX_KEY=<insert mapbox public key>
export MAPBOX_SECRET_KEY=<insert mapbox secret key>
+export SENTRY_DSN=<insert sentry dsn>
```
## Code Style and Quality