Update README.md (Badges update)
This commit is contained in:
parent
9f71e5e7fd
commit
5fcb224d34
1 changed files with 20 additions and 1 deletions
21
README.md
21
README.md
|
|
@ -1,3 +1,5 @@
|
||||||
|
<!------------ Header ------------>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/app_icon.png" width="120" />
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/app_icon.png" width="120" />
|
||||||
|
|
@ -7,20 +9,28 @@
|
||||||
### <p align="center">Material3 Book Reader for Android</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>
|
<p align="center">Dive into the world of adventure as you discover your favorite book's story!</p>
|
||||||
|
|
||||||
|
<!------------ Badges ------------>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
<a href="">[](https://github.com/Acclorite/book-story/releases)</a>
|
<a href="">[](https://github.com/Acclorite/book-story/releases)</a>
|
||||||
<a href="">[]()</a>
|
<a href="">[]()</a>
|
||||||
<a href="">[](https://github.com/Acclorite/book-story/stargazers)</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="">[](https://github.com/Acclorite/book-story/commits/)</a>
|
||||||
<a href="">[](/LICENSE)</a>
|
<a href="">[](/LICENSE)</a>
|
||||||
|
<a href="">[]()</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!------------ Overview ------------>
|
||||||
|
|
||||||
# <p align="center">Overview</p>
|
# <p align="center">Overview</p>
|
||||||
|
|
||||||
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/github_overview.png">
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/github_overview.png">
|
||||||
Built using Jetpack Compose and Kotlin.
|
Built using Jetpack Compose and Kotlin.
|
||||||
|
|
||||||
|
<!------------ Screenshots ------------>
|
||||||
|
|
||||||
## 🖌️ Screenshots + GIF
|
## 🖌️ Screenshots + GIF
|
||||||
|
|
||||||
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/book's-story.gif" width="35%">
|
<img src="https://github.com/Acclorite/book-story/blob/master/assets/readme/book's-story.gif" width="35%">
|
||||||
|
|
@ -36,6 +46,8 @@ Built using 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 guide ------------>
|
||||||
|
|
||||||
## ✈️ Download
|
## ✈️ Download
|
||||||
- _Please note, that the app supports Android versions only from Android 8.0_
|
- _Please note, that the app supports Android versions only from Android 8.0_
|
||||||
|
|
||||||
|
|
@ -63,6 +75,7 @@ _Currently the app is only available on Github, Fdroid is coming.._
|
||||||
- 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 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.
|
- 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
|
## ✨ Features
|
||||||
- 4 supported file formats(.pdf, .txt, .epub, .fb2)
|
- 4 supported file formats(.pdf, .txt, .epub, .fb2)
|
||||||
|
|
@ -81,13 +94,19 @@ _Currently the app is only available on Github, Fdroid is coming.._
|
||||||
- Detailed app functions explanation(Help screen tips)
|
- Detailed app functions explanation(Help screen tips)
|
||||||
- More..
|
- More..
|
||||||
|
|
||||||
|
<!------------ Roadmap ------------>
|
||||||
|
|
||||||
## 😵💫 Upcoming features / 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)._
|
- _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
|
## 🌐 Translation
|
||||||
- English (Default)
|
- English (Default)
|
||||||
- Ukrainian (Default)
|
- Ukrainian (Default)
|
||||||
|
|
||||||
|
<!------------ Credits and License ------------>
|
||||||
|
|
||||||
## 🤗 Credits
|
## 🤗 Credits
|
||||||
- [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)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue