diff --git a/README.md b/README.md index 5b7257ca..98236a4d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@
- +

Book's Story

Material You eBook Reader for Android

Dive into the world of adventure as you discover your favorite book's story!

+--- +
@@ -33,6 +35,8 @@ Enjoy a sleek, customizable **reading app** with modern design, built with Jetpack Compose. It’s open-source, offering you a personalized, ad-free journey through your favorite books! +--- + ## πŸ–ŒοΈ Screenshots @@ -40,14 +44,13 @@ Enjoy a sleek, customizable **reading app** with modern design, built with Jetpa
- + - - - +
-
+ +--- @@ -57,6 +60,8 @@ Enjoy a sleek, customizable **reading app** with modern design, built with Jetpa - Organized Library with categories and chapters in Reader - Highly customizable +--- + ## ✈️ Download @@ -71,15 +76,21 @@ Enjoy a sleek, customizable **reading app** with modern design, built with Jetpa _Don't see your favorite app store? Create an [Issue](https://github.com/Acclorite/book-story/issues)!_ +--- + ### πŸ“² How to download and install - _**Installing from Github**_: Click the "Get it on GitHub" badge above, scroll down, and download **book-story.apk**, or grab the latest APK directly [here](https://github.com/Acclorite/book-story/releases/latest/download/book-story.apk). Once downloaded, locate the APK file and install it. - _**Installing from F-Droid**_: Click the "Get it on F-Droid" badge above, scroll down, and click "Download APK" under your desired release version to download the APK file. Once downloaded, locate the file and install it. - _**Installing from IzzyOnDroid**_: Click the "Get it on IzzyOnDroid" badge above, scroll down, and click "Download" to get the latest APK from IzzyOnDroid. Once downloaded, locate the file and install it. - If you're unsure how to install an APK file, follow [this](https://www.lifewire.com/install-apk-on-android-4177185) guide. +--- + ### 🧭 Afterwards Open the app and follow the basic instructions. If you're unsure how to use the app, refer to the Help screen (accessible via: Library, History, Browse β†’ Three Dots β†’ Help). If you still have questions, feel free to ask in the [Discussions](https://github.com/Acclorite/book-story/discussions/categories/q-a) or create an [Issue](https://github.com/Acclorite/book-story/issues) for areas you think need better documentation. +--- + ## 🌐 Translation @@ -89,6 +100,8 @@ Open the app and follow the basic instructions. If you're unsure how to use the _Help translate the app on [Hosted Weblate](https://hosted.weblate.org/engage/book-story/)._ +--- + ## 🀝 How to contribute @@ -99,7 +112,9 @@ _Help translate the app on [Hosted Weblate](https://hosted.weblate.org/engage/bo - **Report bugs.** Encountered a crash or something went wrong? Create a new [Issue](https://github.com/Acclorite/book-story/issues) with as much detail as possible to help resolve it. - **Translate the app.** You can help make the app accessible in multiple languages. To contribute, visit [Hosted Weblate](https://hosted.weblate.org/engage/book-story/). - **Enjoy the app.** The best contribution is simply using and enjoying the app I spent so much time on! - + +--- + ## πŸ€— Credits @@ -110,6 +125,8 @@ _Help translate the app on [Hosted Weblate](https://hosted.weblate.org/engage/bo - [Weblate Translators](https://hosted.weblate.org/projects/book-story) (Hosted Weblate) - Also listed in About > Credits. +--- + ## 🧾 License