diff --git a/docs/README.md b/docs/README.md index 40b663154..e8cd40057 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,20 +1,25 @@ # Catima + +Copylefted libre software (GPLv3+) card management app. + ![Android CI](https://github.com/TheLastProject/Catima/workflows/Android%20CI/badge.svg) [![Translation status](https://hosted.weblate.org/widgets/catima/-/svg-badge.svg)](https://hosted.weblate.org/engage/catima/) - -Get it on Google Play - Get it on F-Droid Get it on IzzyOnDroid + +Get it on Google Play + ![Logo](https://github.com/TheLastProject/Catima/raw/master/app/src/main/ic_launcher-playstore.png) *Logo by [Rose (TangentFoxy)](http://github.com/TangentFoxy)* -Stores all of your store loyalty cards on your phone, removing the need to carry them around. Currently the following barcode types are supported: +Stores your store loyalty and membership cards on your device, instead of having to carry them around. + +Supported barcodes: - AZTEC - CODABAR @@ -39,16 +44,17 @@ Stores all of your store loyalty cards on your phone, removing the need to carry [](https://github.com/TheLastProject/Catima/raw/master/fastlane/metadata/android/en-US/images/phoneScreenshots/screenshot-07.png) [](https://github.com/TheLastProject/Catima/raw/master/fastlane/metadata/android/en-US/images/phoneScreenshots/screenshot-08.png) -# Migrating from other apps +# Moving data from other apps -[See our migration guides](migrate). +Within the app you can import cards and codes from files, Catima, Loyalty Card Keychain, Voucher Vault, and FidMe. +For FidMe you need to select the barcode type for each entry afterwards. # Building -To build, use the gradle wrapper scripts provided in the top level directory of the project. The following will -compile the application and run all unit tests: +Use the Gradle wrapper scripts provided in the top level directory of the project. +To compile the app and run all unit tests: -GNU/Linux, OSX, UNIX: +Linux|GNU, Unix-like, macOS: ``` ./gradlew build ``` @@ -62,8 +68,8 @@ Windows: [![Translation status](https://hosted.weblate.org/widgets/catima/-/open-graph.png)](https://hosted.weblate.org/engage/catima/) -Please contribute through [our Weblate page](https://hosted.weblate.org/projects/catima/). +Help translate the app to your language from [our Hosted Weblate page](https://hosted.weblate.org/projects/catima/). -# Note from Developer +# Developer Note -This application is based on the great [Loyalty Card Keychain](https://github.com/brarcher/loyalty-card-locker) by [Branden Archer](https://github.com/brarcher). This fork was created due to the original developer having stopped development of this app. +This app is based on the great (but no longer developed) [Loyalty Card Keychain](https://github.com/brarcher/loyalty-card-locker) by [Branden Archer](https://github.com/brarcher).