diff --git a/README.md b/README.md index cbc5a021..bbc75c0d 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,21 @@ This is a community app for the open source project - Mastodon - [Twitter](https://twitter.com/@traewelldroid) -## How it is developed +## Download the app + +[![Download on Google Play](https://raw.githubusercontent.com/Traewelldroid/traewelldroid/dev/assets/badges/google-play-badge.png)](https://play.google.com/store/apps/details?id=de.hbch.traewelling) + -The app is using the official AndroidX framework by Google. Crashes of the app are detected and -transmitted by [Sentry](https://sentry.io). For the production version of the app a self-hosted -Sentry instance is used. +## How it is developed -At the moment the app is available on Google Play. You can download the app there: -[Google Play Store](https://play.google.com/store/apps/details?id=de.hbch.traewelling) +The app is using the official Jetpack Compose framework by Google. Crashes of the app are detected +and transmitted by [Sentry](https://sentry.io). For the production version of the app deployed to +Google Play, a self-hosted Sentry instance is used. Feature Flags are possible and implemented via +a self-hosted Unleash instance. ## Setup -First of all you should copy the `key.properties.example` file in the root directory and copy the -contents into a `key.properties` (for release) or a `dev.properties` (for debug) file. With those -properties the main keys and URLs of the application can be set. +Personalised properties can be configured in the app-level `build.gradle` file. | Property name | Usage | Mandatory | |----------------------|---------------------------------------------|-----------| @@ -37,13 +38,6 @@ properties the main keys and URLs of the application can be set. | `UNLEASH_KEY` | API Key for Unleash API | No | | `WEBHOOK_URL` | URL for accepting Träwelling webhooks | No | -After that, open Android Studio and the project should setup itself automatically. - -### Unleash - -Träwelldroid uses feature toggles with [Unleash](https://getunleash.io) so that features already can -be implemented although they aren't rolled out on depending APIs yet. The official Träwelldroid -build uses a self-hosted Unleash variant hosted in Germany. ## Contributions diff --git a/assets/badges/google-play-badge.png b/assets/badges/google-play-badge.png new file mode 100644 index 00000000..04d4f456 Binary files /dev/null and b/assets/badges/google-play-badge.png differ diff --git a/logo/custom-icons/ic_coach.svg b/assets/custom-icons/ic_coach.svg similarity index 100% rename from logo/custom-icons/ic_coach.svg rename to assets/custom-icons/ic_coach.svg diff --git a/logo/custom-icons/ic_wagon_class.svg b/assets/custom-icons/ic_wagon_class.svg similarity index 100% rename from logo/custom-icons/ic_wagon_class.svg rename to assets/custom-icons/ic_wagon_class.svg diff --git a/logo/logo-anim-square.svg b/assets/logo-anim-square.svg similarity index 100% rename from logo/logo-anim-square.svg rename to assets/logo-anim-square.svg diff --git a/logo/logo-square.svg b/assets/logo-square.svg similarity index 100% rename from logo/logo-square.svg rename to assets/logo-square.svg diff --git a/logo/logo.ai b/assets/logo.ai similarity index 100% rename from logo/logo.ai rename to assets/logo.ai diff --git a/logo/logo.svg b/assets/logo.svg similarity index 100% rename from logo/logo.svg rename to assets/logo.svg diff --git a/logo/traewelldroid.ai b/assets/traewelldroid.ai similarity index 100% rename from logo/traewelldroid.ai rename to assets/traewelldroid.ai diff --git a/logo/traewelldroid.svg b/assets/traewelldroid.svg similarity index 100% rename from logo/traewelldroid.svg rename to assets/traewelldroid.svg