From bd53db62e8257e94cf7824d69a947e655ed0b326 Mon Sep 17 00:00:00 2001 From: Shozikan <142514207+Youwes09@users.noreply.github.com> Date: Sat, 21 Feb 2026 08:06:40 -0600 Subject: [PATCH] [BETA] Updated README Updated README to improve layout, added feature list, and clarified installation instructions. --- README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 44 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e00942b..fb3c6c7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,39 @@
- -

Moku

-

A manga reader frontend for Suwayomi-Server, built with Tauri and React.

+ +

Moku

+

A fast, minimal manga reader frontend for Suwayomi-Server, built with Tauri and React.

+ + + + + + + + + + + + +
--- +## Features + +- Library management with cover art browsing +- Full manga reader with keyboard navigation +- Chapter download queue +- Extension and source management +- Reading history tracking + ## 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 -### Nix +**Nix (recommended)** ```bash nix run github:Youwes09/moku @@ -24,7 +45,7 @@ Or add to your flake: inputs.moku.url = "github:Youwes09/moku"; ``` -### From source +**From source** ```bash git clone https://github.com/Youwes09/moku @@ -43,8 +64,20 @@ pnpm tauri dev ## Stack -- [Tauri v2](https://tauri.app) — app shell -- [React](https://react.dev) + [TypeScript](https://www.typescriptlang.org) — UI -- [Vite](https://vitejs.dev) — frontend build -- [Zustand](https://zustand-demo.pmnd.rs) — state -- [Crane](https://github.com/ipetkov/crane) — Nix Rust builds \ No newline at end of file +| | | +|---|---| +| [Tauri v2](https://tauri.app) | App shell | +| [React](https://react.dev) + [TypeScript](https://www.typescriptlang.org) | UI | +| [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.