# <p align="center">Book's Story 📖</p>

<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>
  <a href="">[![Downloads](https://img.shields.io/github/downloads/Acclorite/book-story/total?color=0273b3&label=Downloads&logo=GitHub)]()</a>
</div>

<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/github_overview.png">
Material3 Book Reader built with Jetpack Compose and Kotlin.

## 🖌️ 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
 - _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
- 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..

## 😵‍💫 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
- English (Default)
- Ukrainian (Default)

## 🤗 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>
