Merge remote-tracking branch 'origin/master'

This commit is contained in:
acclorite 2024-08-06 22:09:50 +03:00
commit 7c97daabfb
2 changed files with 47 additions and 6 deletions

View file

@ -1,13 +1,35 @@
# <p align="center">Book's Story 📖</p> <!------------ Header ------------>
<div align="center"> <div align="center">
<a href="">[![Latest Stable Release](https://img.shields.io/github/release/Acclorite/book-story.svg?label=Release&logo=GitHub)](https://github.com/Acclorite/book-story/releases)</a> <img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/app_icon.png" width="120" />
<a href="">[![Downloads](https://img.shields.io/github/downloads/Acclorite/book-story/total?color=0273b3&label=Downloads&logo=GitHub)]()</a>
</div> </div>
# <p align="center">Book's Story</p>
### <p align="center">Material3 Book Reader for Android</p>
<p align="center">Dive into the world of adventure as you discover your favorite book's story!</p>
<!------------ Badges ------------>
<div align="center">
<a href="">[![Latest Stable Release](https://img.shields.io/github/release/Acclorite/book-story.svg?labelColor=27303D&color=3f719b&label=Release&logo=GitHub)](https://github.com/Acclorite/book-story/releases)</a>
<a href="">[![Downloads](https://img.shields.io/github/downloads/Acclorite/book-story/total?color=3f8f9b&labelColor=27303D&label=Downloads&logo=GitHub)]()</a>
<a href="">[![Stars](https://img.shields.io/github/stars/Acclorite/book-story?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyBoZWlnaHQ9IjI0IiB2aWV3Qm94PSIwIC05NjAgOTYwIDk2MCIgd2lkdGg9IjI0IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogIDxwYXRoIGQ9Im0zNTQtMjQ3IDEyNi03NiAxMjYgNzctMzMtMTQ0IDExMS05Ni0xNDYtMTMtNTgtMTM2LTU4IDEzNS0xNDYgMTMgMTExIDk3LTMzIDE0M1pNMjMzLTgwbDY1LTI4MUw4MC01NTBsMjg4LTI1IDExMi0yNjUgMTEyIDI2NSAyODggMjUtMjE4IDE4OSA2NSAyODEtMjQ3LTE0OUwyMzMtODBabTI0Ny0zNTBaIiBzdHlsZT0iZmlsbDogcmdiKDI0NSwgMjI3LCA2Nik7Ii8%2BCjwvc3ZnPg%3D%3D&color=949b3f&labelColor=27303D&label=Stars)](https://github.com/Acclorite/book-story/stargazers)</a>
<a href="">[![Development Stage](https://img.shields.io/badge/Active-9b3f90?label=Development%20stage&labelColor=27303D)](https://github.com/Acclorite/book-story/commits/)</a>
<a href="">[![Last Commit](https://img.shields.io/github/last-commit/Acclorite/book-story?label=Last%20commit&labelColor=27303D&color=749b3f)](https://github.com/Acclorite/book-story/commits/)</a>
<a href="">[![License: GPL-3.0](https://img.shields.io/github/license/Acclorite/book-story?label=License&labelColor=27303D&color=3f9b75)](/LICENSE)</a>
<a href="">[![Repository Size](https://img.shields.io/github/repo-size/Acclorite/book-story?label=Repository%20size&labelColor=27303D&color=563f9b)]()</a>
</div>
<!------------ Overview ------------>
# <p align="center">Overview</p>
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/github_overview.png"> <img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/github_overview.png">
Material3 Book Reader built with Jetpack Compose and Kotlin. Built using Jetpack Compose and Kotlin.
<!------------ Screenshots ------------>
## 🖌️ Screenshots + GIF ## 🖌️ Screenshots + GIF
@ -24,25 +46,38 @@ Material3 Book Reader built with Jetpack Compose and Kotlin.
_You can find more screenshots in [assets](https://github.com/Acclorite/book-story/tree/master/assets) folder._ _You can find more screenshots in [assets](https://github.com/Acclorite/book-story/tree/master/assets) folder._
<!------------ Download guide ------------>
## ✈️ Download ## ✈️ Download
- _Please note, that the app supports Android versions only from Android 8.0_ - _Please note, that the app supports Android versions only from Android 8.0_
<div align="start"> <div align="left">
[<img src="https://raw.githubusercontent.com/ismartcoding/plain-app/main/assets/get-it-on-github.png" alt='Get it on GitHub' height="80">](https://github.com/Acclorite/book-story/releases/latest) [<img src="https://raw.githubusercontent.com/ismartcoding/plain-app/main/assets/get-it-on-github.png" alt='Get it on GitHub' height="80">](https://github.com/Acclorite/book-story/releases/latest)
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" alt="Get it on IzzyOnDroid" height="80">](https://apt.izzysoft.de/fdroid/index/apk/ua.acclorite.book_story)
</div> </div>
_Currently the app is only available on Github, Fdroid is coming.._ _Fdroid is coming.._
### 📲 How to download and install ### 📲 How to download and install
- _Install from Github_: Click on the "Get it on GitHub" badge above, scroll down and download **book-story.apk** or download the last apk from GitHub [here](https://github.com/Acclorite/book-story/releases/latest/download/book-story.apk). After that, find downloaded file and install it. If you don't understand how to do so, follow [this guide](https://www.lifewire.com/install-apk-on-android-4177185). - _Install from Github_: Click on the "Get it on GitHub" badge above, scroll down and download **book-story.apk** or download the last apk from GitHub [here](https://github.com/Acclorite/book-story/releases/latest/download/book-story.apk). After that, find downloaded file and install it. If you don't understand how to do so, follow [this guide](https://www.lifewire.com/install-apk-on-android-4177185).
- _Install from F-Droid_: Coming soon... - _Install from F-Droid_: Coming soon...
- _Install from IzzyOnDroid_: Click on the "Get it on IzzyOnDroid" badge above, scroll down and click "Download" to download the last apk from IzzyOnDroid. After that, find downloaded file and install it. If you don't understand how to do so, follow [this guide](https://www.lifewire.com/install-apk-on-android-4177185).
### 🗳️ APK Verification
- _APK Verification is an important step to ensure APK integrity and prevent risks from getting infected one._
- For verification you can use tool called [apksigner](https://developer.android.com/tools/apksigner). Which is the part of Android SDK Build Tools, so you need to install that first.
| APK SHA-256 certificate |
|-------------------------------------------------------------------|
| a661a0c81f138e53dff32f8fdc1dd19f8130523914027e2c0296fe245131a7d4 |
### 🧭 Afterwards ### 🧭 Afterwards
- Open the app and follow basic instructions. - Open the app and follow basic instructions.
- If you don't understand how to use the app, please read everything in the app's Help Screen. (You can find it in: Library, History, Browse → Three Dots → Help) - If you don't understand how to use the app, please read everything in the app's Help Screen. (You can find it in: Library, History, Browse → Three Dots → Help)
- If you still have questions, please feel free to ask in [Discussions](https://github.com/Acclorite/book-story/discussions/categories/q-a), or create an [Issue](https://github.com/Acclorite/book-story/issues) if you feel like some area should be documented better. - If you still have questions, please feel free to ask in [Discussions](https://github.com/Acclorite/book-story/discussions/categories/q-a), or create an [Issue](https://github.com/Acclorite/book-story/issues) if you feel like some area should be documented better.
<!------------ Features ------------>
## ✨ Features ## ✨ Features
- 4 supported file formats(.pdf, .txt, .epub, .fb2) - 4 supported file formats(.pdf, .txt, .epub, .fb2)
@ -61,13 +96,19 @@ _Currently the app is only available on Github, Fdroid is coming.._
- Detailed app functions explanation(Help screen tips) - Detailed app functions explanation(Help screen tips)
- More.. - More..
<!------------ Roadmap ------------>
## 😵‍💫 Upcoming features / Roadmap ## 😵‍💫 Upcoming features / Roadmap
- _You can track project's progress, see what's coming and what is already implemented in [Book's Story: Development Roadmap](https://github.com/users/Acclorite/projects/1)._ - _You can track project's progress, see what's coming and what is already implemented in [Book's Story: Development Roadmap](https://github.com/users/Acclorite/projects/1)._
<!------------ Translation ------------>
## 🌐 Translation ## 🌐 Translation
- English (Default) - English (Default)
- Ukrainian (Default) - Ukrainian (Default)
<!------------ Credits and License ------------>
## 🤗 Credits ## 🤗 Credits
- [Tachiyomi (Mihon)](https://github.com/mihonapp/mihon) (Github) - [Tachiyomi (Mihon)](https://github.com/mihonapp/mihon) (Github)
- [Libre-Sudoku](https://github.com/kaajjo/Libre-Sudoku) (Github) - [Libre-Sudoku](https://github.com/kaajjo/Libre-Sudoku) (Github)

BIN
assets/readme/app_icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9 KiB