do-readme-update

Installation
SKILL.md

README Update

Make every claim in the README match the repo as it is now. Edit only what drifted; keep the author's structure, headings, and voice.

1. Find the README and anything that generates it

  • The root README.md, plus nested package or workspace READMEs when the change touched them.
  • Generated regions: marker comments (<!-- ... start --> / <!-- ... end -->), a header saying the file is generated, or a generator: scripts/*readme*, a package.json script, a Makefile, justfile, or Taskfile target, or docs tooling. Project AGENTS.md or CONTRIBUTING.md may name the command.
  • Never hand-edit a generated region. Run its generator, then edit only the hand-written parts.

2. Collect the truth from the repo

Read sources, not memory or the README itself:

  • Install and setup: manifests (package.json, pyproject.toml, Cargo.toml, go.mod, Gemfile, ...), the lockfile's package manager, runtime versions (.nvmrc, .tool-versions, engines, rust-toolchain).
  • Commands: manifest scripts, Makefile/justfile/Taskfile targets, CLI --help output.
  • Config: .env.example, config files and schemas, flags.
  • Structure: the top-level directories the README describes.
  • What changed: git log --oneline $(git log -1 --format=%H -- README.md)..HEAD and that range's diff show everything since the README was last touched.
Installs
2
GitHub Stars
2
First Seen
Oct 7, 2026