gamezonline/Moku
1
0
Fork 0
mirror of https://github.com/moku-project/Moku.git synced 2026-06-13 01:09:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

[BETA] Updated README

Browse Source 
Updated README to improve layout, added feature list, and clarified installation instructions.
This commit is contained in:
Shozikan
2026-02-21 08:06:40 -06:00
committed by GitHub
parent 09554c68df
commit bd53db62e8
1 changed files with 44 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+44 -11
View File
@@ -1,18 +1,39 @@
<div align="center"> <div align="center">
<img src="src/assets/Moku-Icon.svg" width="80" /> <img src="src/assets/Moku-Icon.svg" width="256" style="display:block;margin:0 auto;" />
<h1>Moku</h1> <h1 style="margin:4px 0 2px;">Moku</h1>
<p>A manga reader frontend for <a href="https://github.com/Suwayomi/Suwayomi-Server">Suwayomi-Server</a>, built with Tauri and React.</p> <p style="margin:0 0 12px;">A fast, minimal manga reader frontend for <a href="https://github.com/Suwayomi/Suwayomi-Server">Suwayomi-Server</a>, built with Tauri and React.</p>
<table>
<tr>
<td><img src=".github/screenshots/Library-Page.png" width="100%" /></td>
<td><img src=".github/screenshots/Libary-Browse.png" width="100%" /></td>
<td><img src=".github/screenshots/Series-Detail.png" width="100%" /></td>
</tr>
<tr>
<td><img src=".github/screenshots/Search-Bar.png" width="100%" /></td>
<td><img src=".github/screenshots/Download-Manager.png" width="100%" /></td>
<td><img src=".github/screenshots/Settings-1.png" width="100%" /></td>
</tr>
</table>
</div> </div>
--- ---
## Features
- Library management with cover art browsing
- Full manga reader with keyboard navigation
- Chapter download queue
- Extension and source management
- Reading history tracking
## Requirements ## Requirements
- [Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server) running on `http://127.0.0.1:4567` [Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server) must be running at `http://127.0.0.1:4567`.
## Installation ## Installation
### Nix **Nix (recommended)**
```bash ```bash
nix run github:Youwes09/moku nix run github:Youwes09/moku
@@ -24,7 +45,7 @@ Or add to your flake:
inputs.moku.url = "github:Youwes09/moku"; inputs.moku.url = "github:Youwes09/moku";
``` ```
### From source **From source**
```bash ```bash
git clone https://github.com/Youwes09/moku git clone https://github.com/Youwes09/moku
@@ -43,8 +64,20 @@ pnpm tauri dev
## Stack ## Stack
- [Tauri v2](https://tauri.app) — app shell | | |
- [React](https://react.dev) + [TypeScript](https://www.typescriptlang.org) — UI |---|---|
- [Vite](https://vitejs.dev) — frontend build | [Tauri v2](https://tauri.app) | App shell |
- [Zustand](https://zustand-demo.pmnd.rs) — state | [React](https://react.dev) + [TypeScript](https://www.typescriptlang.org) | UI |
- [Crane](https://github.com/ipetkov/crane) — Nix Rust builds | [Vite](https://vitejs.dev) | Frontend build |
| [Zustand](https://zustand-demo.pmnd.rs) | State management |
| [Crane](https://github.com/ipetkov/crane) | Nix Rust builds |
## License
Distributed under the [Apache 2.0 License](./LICENSE).
---
## Disclaimer
Moku does not host any content. The developer(s) of this application have no affiliation with the content providers available freely on the internet.