@yorz/cli 0.9.3 → 0.11.0

package/README.md

@@ -1,32 +1,42 @@
-# YorZ
+<div align="center">
 
-**English** | [中文](./README_CN.md)
+# YorZ · Step Into the New Era of AI Coding
 
----
+### Coding Made Simple and Comfortable
+
+_A minimal, zero-barrier interaction design with mobile-first best practices — you can even "write" code lying down_
+
+### Unleash Your Agents
+
+_Let Claude / Codex run 10 tasks at once, with zero interference_
+
+### A Picture Is Worth a Thousand Words
 
-## Why YorZ
+_Decide from diagrams, and free developers from wading through docs and code_
 
-YorZ (Youzi) keeps vibe coding from turning your codebase into a black box.  
-It also addresses a common failure mode in SDD (spec-driven development): developers stop reading the specs.
+---
+
+**English** · [中文](./README_CN.md) · [📖 User Guide](./docs/User-Guide.md)
 
-Agents can generate documents so quickly that developers get overloaded and pushed out of the workflow.  
-YorZ turns spec information into visual, structured views and provides an SDD-focused UI, so Agents can work at full speed without burying developers in text.
+</div>
 
 ![preview](./docs/preview.png)
 
-## Features
+https://github.com/user-attachments/assets/d82f6a5c-07e9-403c-b2b5-4b60e3c5db94
 
-- A built-in lightweight SDD skill with a UI tailored to SDD workflows
-- Visual diagrams that make Agent output easier to read and understand
-- One-click git worktree isolation, with concurrent Agents running on separate tasks
-- Minimal user intervention while key decisions stay under user control
-- Deep debug mode that uses evidence chains to diagnose hard problems Agents struggle to solve
-- Works with mainstream Coding Agents including Claude Code, OpenCode, and Codex
+## What Makes YorZ (柚子) Different
 
-[_User Guide_](./docs/User-Guide.md)
+- Minimal interaction design with a zero-barrier learning curve — friendly to coding beginners
+- Mobile-first best practices — you can even "write" code lying down
+- Built-in spec-driven development workflow that tames large projects and complex requirements
+- Concurrent tasks that run in isolation, squeezing every drop out of your Agents
+- Rich technical diagrams that elevate docs and code into insight for faster understanding and sharper decisions
+- Compatible with mainstream Agents, with seamless multi-Agent switching
 
 ## Installation
 
+Requires Node.js >= 22.19.0 (the floor comes from the bundled Pi Agent SDK).
+
 ```bash
 pnpm add -g @yorz/cli
 
@@ -43,9 +53,7 @@ npm install -g @yorz/cli
 yorz serve
 ```
 
-Start the YorZ Service. It runs in the background by default. Open `http://localhost:7423` in your browser to access the dashboard.
-
-On startup, `yorz serve` automatically checks the `yorz-spec` skill. If it is missing or out of date, YorZ installs or updates it for every supported Agent (Claude Code / OpenCode / Codex) and prints the result before starting the Service.
+This starts the YorZ Service, which runs in the background by default. Open `http://localhost:7423` in your browser to access the dashboard.
 
 To stop the background service:
 
@@ -53,31 +61,6 @@ To stop the background service:
 yorz serve stop
 ```
 
-### Add a Project
-
-```bash
-yorz add /path/to/your/project
-```
-
-Initialize the directory as a YorZ project by creating `.yorz/` config, registering it with the Service, and adding `.yorz/tmp` to `.gitignore`.
-
-The `yorz-spec` skill teaches your AI Agent how to drive spec documents through the plan / tasks / execute / done stages. It is installed and kept up to date automatically by `yorz serve` as described above, so no manual installation is required.
-
-## Command Reference
-
-| Command           | Description                                                            |
-| ----------------- | ---------------------------------------------------------------------- |
-| `yorz serve`      | Start or reuse the background YorZ Service with multi-project support. |
-| `yorz serve stop` | Stop the background YorZ Service.                                      |
-| `yorz add <path>` | Initialize and register a directory as a YorZ project.                 |
-
-### Global Options
-
-| Option          | Description                   |
-| --------------- | ----------------------------- |
-| `-V, --version` | Print the YorZ version.       |
-| `-h, --help`    | Display help for any command. |
-
 ## Development
 
 ```bash