Readme
This commit is contained in:
Acclorite 2024-04-17 15:13:48 +03:00 committed by GitHub
parent 6cb308bc0b
commit c2203e0717
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

60
README.md Normal file
View file

@ -0,0 +1,60 @@
# <p align="center">Book's Story 📖</p>
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/github_overview.png">
Material3 Book Reader built with Jetpack Compose and Kotlin.
## ⬇️ Download
<div align="center"> </br>
<a href="">[![Book's Story](https://img.shields.io/github/release/Acclorite/book-story.svg?label=Latest%20Stable&labelColor=06599d&color=043b69)](https://github.com/Acclorite/book-story/releases)</a>
<p align="center"><em>Requires Android 8.0 (API level 26) or higher.</em></p>
</div>
## 🖌️ Screenshots
<div>
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Library.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/History.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Browse.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Reader.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Start.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Book Info.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/About.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Help.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Settings.png" width="20%" />
<img src="https://github.com/Acclorite/book-story/blob/master/assets/Reader Settings.png" width="20%" />
</div>
## ✨ Features
- 3 supported file formats(.pdf, .txt, .epub)
- 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
- Material3 latest design guidelines
- 7 unique themes
- MaterialYou Dynamic Theme support
- Simple UI
- Detailed app functions explanation(help screen)
- More..
## 😵‍💫 Upcoming features
- [You tell me!](https://github.com/Acclorite/book-story/labels/enhancement)
## 🌐 Translation
- English (Default)
- Ukrainian (Default)
## 🤗 Credits
- Tachiyomi (Design template, no code is taken)
- [Libre-Sudoku](https://github.com/kaajjo/Libre-Sudoku) (Readme template, no code is taken)
## 🧾 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>