128 lines
7.4 KiB
Markdown
128 lines
7.4 KiB
Markdown
<!------------ Header ------------>
|
|
|
|
<div align="center">
|
|
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/app_icon.png" width="120" />
|
|
</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="">[](https://github.com/Acclorite/book-story/releases)</a>
|
|
<a href="">[]()</a>
|
|
<a href="">[](https://github.com/Acclorite/book-story/stargazers)</a>
|
|
<a href="">[](https://github.com/Acclorite/book-story/commits/)</a>
|
|
<a href="">[](https://github.com/Acclorite/book-story/commits/)</a>
|
|
<a href="">[](/LICENSE)</a>
|
|
<a href="">[]()</a>
|
|
</div>
|
|
|
|
<!------------ Overview ------------>
|
|
|
|
# <p align="center">Overview</p>
|
|
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/github_overview.png">
|
|
Built using Jetpack Compose and Kotlin.
|
|
|
|
<!------------ Screenshots ------------>
|
|
|
|
## 🖌️ Screenshots + GIF
|
|
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/book's-story.gif" width="35%">
|
|
<div>
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Library Dark + Frame.png" width="30%" />
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Book-Info Dark + Frame.png" width="30%" />
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Reader Dark + Frame.png" width="30%" />
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Library Light + Frame.png" width="30%" />
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Book-Info Light + Frame.png" width="30%" />
|
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Reader Light + Frame.png" width="30%" />
|
|
</div>
|
|
</br>
|
|
|
|
_You can find more screenshots in [assets](https://github.com/Acclorite/book-story/tree/master/assets) folder._
|
|
|
|
<!------------ Download guide ------------>
|
|
|
|
## ✈️ Download
|
|
- _Please note, that the app supports Android versions only from Android 8.0_
|
|
|
|
<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://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>
|
|
|
|
_Fdroid is coming.._
|
|
|
|
### 📲 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 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
|
|
- 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 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
|
|
- 4 supported file formats(.pdf, .txt, .epub, .fb2)
|
|
- Color Presets for Reader
|
|
- Categories to organize your Library
|
|
- Check for app updates on app startup
|
|
- Anti error protection(you cannot add/update a book if it is not valid)
|
|
- Highly customizable Reader
|
|
- Double click translation(sends to the external translator)
|
|
- Translate and Dictionary options when text is selected in Reader
|
|
- Material3 latest design guidelines
|
|
- 7 unique themes
|
|
- MaterialYou Dynamic Theme support
|
|
- Simple UI
|
|
- Tablet UI support
|
|
- Detailed app functions explanation(Help screen tips)
|
|
- More..
|
|
|
|
<!------------ 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)._
|
|
|
|
<!------------ Translation ------------>
|
|
|
|
## 🌐 Translation
|
|
- English (Default)
|
|
- Ukrainian (Default)
|
|
|
|
<!------------ Credits and License ------------>
|
|
|
|
## 🤗 Credits
|
|
- [Tachiyomi (Mihon)](https://github.com/mihonapp/mihon) (Github)
|
|
- [Libre-Sudoku](https://github.com/kaajjo/Libre-Sudoku) (Github)
|
|
- [Kitsune](https://github.com/Drumber/Kitsune) (Github)
|
|
- [Material Design Icons](https://fonts.google.com/icons) (Google Fonts)
|
|
- Also listed in About > Credits.
|
|
|
|
## 🧾 License
|
|
<div align="center">
|
|
<pre>
|
|
GNU GENERAL PUBLIC LICENSE
|
|
Version 3, 29 June 2007 </br>
|
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
Everyone is permitted to copy and distribute verbatim copies
|
|
of this license document, but changing it is not allowed.
|
|
</pre>
|
|
</div>
|