From cfc161e404db3dcf531f5b72164a1df2095a4787 Mon Sep 17 00:00:00 2001 From: Acclorite <140836141+Acclorite@users.noreply.github.com> Date: Tue, 30 Jul 2024 12:24:32 +0300 Subject: [PATCH] Update README.md --- README.md | 41 ++++++++++++++++++++++++++++------------- 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9d04980c..528ab3d3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ #

Book's Story ๐Ÿ“–

- + [![Latest Stable Release](https://img.shields.io/github/release/Acclorite/book-story.svg?label=Release&logo=GitHub)](https://github.com/Acclorite/book-story/releases) [![Downloads](https://img.shields.io/github/downloads/Acclorite/book-story/total?color=0273b3&label=Downloads&logo=GitHub)]()
@@ -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._ +## โœˆ๏ธ Download + - _Please note, that the app supports Android versions only from Android 8.0_ + +
+ + [Get it on GitHub](https://github.com/Acclorite/book-story/releases/latest) +
+ +_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) -- Built-in offline translator(only one time download per language) +- 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 -- Detailed app functions explanation(help screen) +- Tablet UI support +- Detailed app functions explanation(Help screen tips) - More.. -## ๐Ÿ˜ตโ€๐Ÿ’ซ Upcoming features -- New file formats -- Custom color presets for Reader -- [You tell me!](https://github.com/Acclorite/book-story/labels/enhancement) +## ๐Ÿ˜ตโ€๐Ÿ’ซ 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) @@ -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) - [Libre-Sudoku](https://github.com/kaajjo/Libre-Sudoku) (Github) - [Kitsune](https://github.com/Drumber/Kitsune) (Github) -- [Freepik](https://www.flaticon.com/authors/freepik) (Flaticon) -- [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) +- [Material Design Icons](https://fonts.google.com/icons) (Google Fonts) - Also listed in About > Credits. ## ๐Ÿงพ License