Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YohannesTz committed Oct 10, 2024
1 parent ce27375 commit 534f755
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
<p align="center">
<img src="/screenshots/banner.png" alt="Satori banner">
<h2 align="center">Satori</h2>
</p>

Welcome to Satori, an app to explore and discover books using the Google Books API. "Satori" means "enlightenment" in Japanese, and the app aims to bring knowledge and light through books.

# Satori - Enlighten Your Reading
## Download

Welcome to **Satori**, an app to explore and discover books using the Google Books API. "Satori" means "enlightenment" in Japanese, and the app aims to bring knowledge and light through books.
You can download the latest release from [here](https://github.com/yohannesTz/satori/releases).

## Screenshots

<p align="center">
<img src="/screenshots/1.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/2.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/3.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/4.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/5.png" width="30%" height="30%" alt="screenshot">
</p>

## Features

Expand Down Expand Up @@ -70,16 +86,6 @@ The app follows MVVM (Model-View-ViewModel) architecture:
- **ViewModel**: Handles all the business logic and communicates with the Model to get the necessary data.
- **View (Compose)**: Displays data on the screen and listens to changes from the ViewModel.

## Screenshots

<p align="center">
<img src="/screenshots/1.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/2.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/3.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/4.png" width="30%" height="30%" alt="screenshot">
<img src="/screenshots/5.png" width="30%" height="30%" alt="screenshot">
</p>


## License

Expand Down
Binary file removed screenshots/app_logo.webp
Binary file not shown.
Binary file added screenshots/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 534f755

Please sign in to comment.