diff --git a/README.md b/README.md index 6332211..77cff42 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ -Black Candy for Android +# Black Candy for Android + +[![CI](https://github.com/blackcandy-org/android/actions/workflows/ci.yml/badge.svg)](https://github.com/blackcandy-org/android/actions/workflows/ci.yml) + +The official Black Candy Android app. To use this app, you must have a Black Candy server set up. For more information, please visit https://github.com/blackcandy-org/blackcandy + +## Get the app + +You can download the APK from [GitHub Releases](https://github.com/blackcandy-org/android/releases/latest). + +## Screenshots + +| ![Home Screenshot](https://raw.githubusercontent.com/blackcandy-org/android/master/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png) | ![Library Screenshot](https://raw.githubusercontent.com/blackcandy-org/android/master/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png) | ![Playback Screenshot](https://raw.githubusercontent.com/blackcandy-org/android/master/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png) | ![Light Theme Screenshot](https://raw.githubusercontent.com/blackcandy-org/android/master/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png) | +| ---------------------------------------------- | -------------------------------------------- | ------------------------------------------- | ------------------------------------------- | \ No newline at end of file