Update README.md

This commit is contained in:
Acclorite 2024-07-30 12:24:32 +03:00 committed by GitHub
parent 2114803c22
commit cfc161e404
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -24,25 +24,45 @@ 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
- _Please note, that the app supports Android versions only from Android 8.0_
<div align="start">
[<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)
</div>
_Currently the app is only available on Github, 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...
### 🧭 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) - 4 supported file formats(.pdf, .txt, .epub, .fb2)
- Built-in offline translator(only one time download per language) - Color Presets for Reader
- Categories to organize your Library - Categories to organize your Library
- Check for app updates on app startup - Check for app updates on app startup
- Anti error protection(you cannot add/update a book if it is not valid) - Anti error protection(you cannot add/update a book if it is not valid)
- Highly customizable Reader - Highly customizable Reader
- Double click translation(sends to the external translator)
- Translate and Dictionary options when text is selected in Reader - Translate and Dictionary options when text is selected in Reader
- Material3 latest design guidelines - Material3 latest design guidelines
- 7 unique themes - 7 unique themes
- MaterialYou Dynamic Theme support - MaterialYou Dynamic Theme support
- Simple UI - Simple UI
- Detailed app functions explanation(help screen) - Tablet UI support
- Detailed app functions explanation(Help screen tips)
- More.. - More..
## 😵‍💫 Upcoming features ## 😵‍💫 Upcoming features / Roadmap
- New file formats - _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)._
- Custom color presets for Reader
- [You tell me!](https://github.com/Acclorite/book-story/labels/enhancement)
## 🌐 Translation ## 🌐 Translation
- English (Default) - English (Default)
@ -52,12 +72,7 @@ _You can find more screenshots in [assets](https://github.com/Acclorite/book-sto
- [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)
- [Kitsune](https://github.com/Drumber/Kitsune) (Github) - [Kitsune](https://github.com/Drumber/Kitsune) (Github)
- [Freepik](https://www.flaticon.com/authors/freepik) (Flaticon) - [Material Design Icons](https://fonts.google.com/icons) (Google Fonts)
- [Anggara](https://www.flaticon.com/authors/anggara) (Flaticon)
- [Google](https://www.flaticon.com/authors/google) (Flaticon)
- [Creative Stall Premium](https://www.flaticon.com/authors/creative-stall-premium) (Flaticon)
- [Gajah Mada](https://www.flaticon.com/authors/gajah-mada) (Flaticon)
- [mavadee](https://www.flaticon.com/authors/mavadee) (Flaticon)
- Also listed in About > Credits. - Also listed in About > Credits.
## 🧾 License ## 🧾 License