✒️ Update README.md

* New screenshots
* Added line separators
This commit is contained in:
Acclorite 2024-12-27 12:55:52 +02:00 committed by GitHub
parent f8134607f7
commit b69e2cb444
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,12 +1,14 @@
<!------------ Header ------------>
<div align="center">
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/app_icon.png" width="120" />
<img src="https://github.com/Acclorite/book-story/blob/master/fastlane/metadata/android/en-US/images/icon_2.png" width="120" />
<h1>Book's Story</h1>
<h3>Material You eBook Reader for Android</h3>
<p>Dive into the world of adventure as you discover your favorite book's story!</p>
</div>
---
<!------------ Badges ------------>
<div align="center">
@ -33,6 +35,8 @@
Enjoy a sleek, customizable **reading app** with modern design, built with Jetpack Compose. Its open-source, offering you a personalized, ad-free journey through your favorite books!
---
<!------------ Screenshots ------------>
## 🖌️ Screenshots
@ -40,14 +44,13 @@ Enjoy a sleek, customizable **reading app** with modern design, built with Jetpa
<div>
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width="30%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width="30%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/9.png" width="30%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width="30%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" width="30%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width="30%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/8.png" width="30%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width="45%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width="45%" />
<img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width="30%" />
</div>
</br>
---
<!------------ Features ------------>
@ -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 guide ------------>
## ✈️ 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 ------------>
## 🌐 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/)._
---
<!------------ Contribution ------------>
## 🤝 How to contribute
@ -100,6 +113,8 @@ _Help translate the app on [Hosted Weblate](https://hosted.weblate.org/engage/bo
- **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 and License ------------>
## 🤗 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
<div align="center">
<pre>