update-readme

Installation
SKILL.md

README update

Bring the requested README file or files into agreement with the current project. A README update is a scoped documentation edit: identify the target path, inspect the repository as it exists now, preserve requested content and project voice, and write only the files the user named or clearly implied.

Scope and routing

  • If the user names a path, package, module, or nested README, use that path. Do not redirect it to a root README.
  • If the user says “README” without a path, inspect the repository root and use its README as the default. Confirm the target when multiple plausible roots exist.
  • Update both README.md and README.zh-CN.md only when the user requests bilingual synchronization or names both files. A single-language request changes only that file.
  • Preserve an existing header, badge, language toggle, structure, and project-specific conventions unless the user requests a redesign. An existing README keeps its own structure and needs no skeleton, so a normal update reads no template.
  • An existing README file is the target even when the user says “create a README”. Edit it and preserve its structure. Treat the work as new only when no README exists at the target path.
  • A structural rewrite needs an explicit request: a redesign, a restructure, or a named profile to adopt. A request to update, sync, or audit is not a rewrite, so preserve the existing sections.
  • Read references/template.md for a new README, or for a structural rewrite that the user requested. Choose the profile by repository shape: a collection repository or a single-artifact repository. A single-artifact repository must not receive a catalog section.
  • Add a section from a profile only when the section has a real target. Never add a licence section, a badge, or a translation link that the repository does not already supply.
  • A review, inventory, or suggested diff is read-only until the user asks to write.

Ground truth

Before drafting, inspect the selected repository or package:

Installs
5
Repository
fradser/skills
GitHub Stars
4
First Seen
May 22, 2026