Atte149/book-reader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme (#3)

Browse source 
docs: Revamp README and add APK naming convention

This commit introduces a complete overhaul of the `README.md` to improve project presentation. Key changes include:
*   Adds a new header with the app icon and a Google Play badge.
*   Updates the feature graphic and includes a note distinguishing the OSS version from the Play Store version.
*   Refines the "Open Source Libraries" section to be more structured.
*   Moves the main preview image into the `docs` directory.

Additionally, the `app/build.gradle.kts` file is updated to configure a standardized naming convention for output APK files, including flavor, version, and build type.

* refactor copyright headers and fix README icon alignment

This commit introduces two main changes across the codebase:

The `spotless/copyright.kt` template have been updated for consistency:
*   The author name is simplified from "Episteme Authors" to "Episteme".
*   The contact email prefix is shortened from "Electronic mail:" to "mail:".

Second, the `README.md` file is adjusted to correct the vertical alignment of the app icon with the project title.
This commit is contained in:
Aryan 2026-02-25 21:30:28 +05:30 • committed by GitHub
parent 92c2bf2822
commit c6363f3061
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
107 changed files with 214 additions and 214 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -1,8 +1,8 @@
<div align="center">
<h1>
<img src="docs/ICON.png" height="48" style="vertical-align: middle; border-radius: 12px;" alt="Episteme Reader Icon"/>
&nbsp;Episteme Reader
<img src="docs/ICON.png" height="48" width="48" align="middle" alt="Episteme Reader Icon"/>
<span>&nbsp;Episteme Reader</span>
</h1>
<p>A native Android document reader application built with Kotlin and Jetpack Compose.</p>