diff --git a/README.md b/README.md index 6be6c3f..657696b 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,173 @@ -# sv +
+ Moku +
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +
-## Creating a project +[![Release](https://www.shieldcn.dev/github/release/moku-project/Moku.svg?variant=outline&size=default)](https://github.com/moku-project/Moku/releases/latest) +![GitHub Downloads](https://www.shieldcn.dev/github/downloads/moku-project/Moku.svg?variant=outline&size=default) +[![Stars](https://www.shieldcn.dev/github/stars/moku-project/Moku.svg?variant=outline&size=default)](https://github.com/moku-project/Moku) +[![Discord](https://www.shieldcn.dev/discord/members/x97hj8zR72.svg?variant=outline&size=default)](https://discord.gg/x97hj8zR72) -If you're seeing this, you've probably already done this step. Congrats! +
-```sh -# create a new project -npx sv create my-app +
+ +Moku is a fast, minimal manga reader frontend for [Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server). It wraps Suwayomi's GraphQL API in a lightweight Tauri app — no Electron overhead. + +--- + +## Screenshots + +
+ Home +
+ +
+ Search + Tag Search + Settings + Preview + Downloads + Reader Settings +
+ +
+ View all screenshots → +
+ +--- + +## Features + +- **Library management** — organize manga into folders, track unread counts, filter by genre +- **Per-folder sorting & filtering** — each folder has its own independent sort (unread, A–Z, recently read, latest chapter, and more) and publication status filter (Ongoing, Completed, Hiatus, etc.) +- **Built-in reader** — single page, long strip, configurable fit modes, customizable keybinds +- **Markers** — pin color-coded notes to any page while reading; markers appear as dots on the progress bar and are browseable under Series Detail → Manage → Markers +- **Extension support** — install and manage Suwayomi extensions directly from the app +- **Download management** — queue and monitor chapter downloads with progress toasts +- **Automation** — pre-download titles automatically and optionally delete chapters after reading (accessible from Series Detail) +- **Discord Rich Presence** — shows manga title, current chapter, and elapsed timer in your Discord status; configurable in Settings → General +- **Auto-start server** — optionally launch Suwayomi in the background on startup +- **Multiple themes** — Dark, Light, Midnight, Warm, High Contrast, and more +- **Auto-updates** — in-app update checker with silent background notifications +- **Improved NSFW filtering** — expanded tag parser gives the Hide NSFW setting better coverage across sources + +--- + +## Installation + +
+ +![Runs on Windows](https://www.shieldcn.dev/badge/Runs%20on-Windows-0078D4.svg?logo=windows&logoColor=fff) +![Runs on Linux](https://www.shieldcn.dev/badge/Runs%20on-Linux-FCC624.svg?logo=linux&logoColor=000) +![Runs on macOS](https://www.shieldcn.dev/badge/Runs%20on-MacOS-000000.svg?mode=light&logo=apple&logoColor=fff) + +
+ +### Windows + +**winget:** + +```powershell +winget install Moku.Moku ``` -To recreate this project with the same configuration: +> Thanks to [@frozenKelp](https://github.com/frozenKelp) for setting up and maintaining the winget package through v0.9.0. -```sh -# recreate this project -pnpm dlx sv@0.15.3 create --template minimal --types ts --install pnpm . +Or download the `.exe` installer from the [releases page](https://github.com/moku-project/Moku/releases/latest). Suwayomi-Server and a JRE are bundled. + +### Linux (Flatpak, recommended) + +Suwayomi-Server and a bundled JRE are included — no separate install needed. + +```bash +flatpak install io.github.moku_app.Moku ``` -## Developing +Or download the latest `moku.flatpak` from the [releases page](https://github.com/moku-project/Moku/releases/latest) and install manually: -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```sh -npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open +```bash +flatpak install moku.flatpak ``` -## Building +### Nix -To create a production version of your app: - -```sh -npm run build +```bash +nix run github:moku-project/Moku ``` -You can preview the production build with `npm run preview`. +Add to your flake: -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +```nix +inputs.moku.url = "github:moku-project/Moku"; +``` + +### macOS + +Download the `.dmg` from the [releases page](https://github.com/moku-project/Moku/releases/latest). + +> **Note:** Builds are ad-hoc signed. On first launch you may need to run: +> ```bash +> xattr -rd com.apple.quarantine /Applications/Moku.app +> ``` + +--- + +## Requirements + +If you're not using the bundled Flatpak or Windows installer, [Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server) must be running separately. By default Moku connects to `http://127.0.0.1:4567`. + +You can point Moku at any Suwayomi instance — local or remote — via **Settings → General → Server URL**. + +--- + +## Development + +**Prerequisites:** [Rust](https://rustup.rs), [Node.js](https://nodejs.org), [pnpm](https://pnpm.io), and [Tauri v2 prerequisites](https://tauri.app/start/prerequisites/). + +```bash +git clone https://github.com/moku-project/Moku +cd Moku +pnpm install +pnpm tauri:dev +``` + +Or with Nix: + +```bash +nix develop +pnpm install +pnpm tauri:dev +``` + +--- + +## Stack + +| | | +|---|---| +| [Tauri v2](https://tauri.app) | Native app shell | +| [Svelte 5](https://svelte.dev) + [SvelteKit 2](https://kit.svelte.dev) + [TypeScript](https://www.typescriptlang.org) | UI | +| [Vite 8](https://vitejs.dev) | Frontend bundler | +| [Nixpkgs stdenv](https://nixos.org/manual/nixpkgs/stable/) | Nix builds | + +--- + +## Community + +Questions, feedback, or just want to hang out — join the Discord. + +[![Discord](https://www.shieldcn.dev/discord/members/x97hj8zR72.svg?variant=secondary&size=large)](https://discord.gg/x97hj8zR72) + +--- + +## License + +Distributed under the [Apache 2.0 License](./LICENSE). + +--- + +## Disclaimer + +Moku does not host or distribute any content. The developers have no affiliation with any content providers accessible through connected sources. \ No newline at end of file