| name | update-readme |
| description | Updates ONLY the root-level README.md and README.zh-CN.md. NEVER update README files in subdirectories, packages, modules, or nested paths. Use this skill whenever the user asks to "update the README", "sync the docs", "update documentation", "reflect latest changes in README", or wants both the English and Chinese READMEs to match the current project. |
Update README
CRITICAL: Root-Only Scope
This skill operates ONLY on the root-level README.md and README.zh-CN.md of the project. It NEVER touches README files in subdirectories, packages, modules, or any nested path.
Root-level means the directory that contains the project's main manifest (package.json, pyproject.toml, go.mod, Cargo.toml, etc.) or the git repository root.
If the user asks about a README in a subdirectory, do NOT apply this skill. Handle it as a plain file edit without the update-readme workflow.
Keep README.md (English, primary) and README.zh-CN.md (Simplified Chinese, secondary) in sync with the project's actual current state. Both files must be accurate, complete, and consistent with each other.
CRITICAL: Ground Truth and Header Format
- Write from ground truth, not from memory or assumption. Every skill/component listed in the README MUST exist in the repository at the time of writing. Verify existence before writing.
- Every README MUST open with the exact header structure shown in the "Header Format" section below, including the language toggle. Adapt badges, project name, and description to the project; do not omit the structure.
- Do not output README content as a code block in the conversation. Use the Edit or Write tool to write the files directly.
Header Format (Required)
Every README must open with this exact structure — adapt the badges, project name, and description to the project at hand:
