Skip to content
Steve Morin

/readme-sync

Does the README still describe the code?

What it does

Verifies README.md against the current state of the project and updates it where it has drifted.

When to reach for it

Before a release, after a refactor that moved commands around, or whenever the install instructions feel suspicious.

It's working if

  • The README's install steps run clean on a machine that has never seen the project.
  • It tells you a section is fine rather than rewriting it to look busy.
  • Anything it changed maps to a real difference in the code, not a style preference.

Install this skill

Then type /readme-sync in your agent.

npx skills@latest add smorinlabs/smorinlabs-harness -s readme-sync

Or install the whole repo-hygiene plugin — this skill plus 4 others.

/plugin install repo-hygiene@smorinlabs-harness

Where it fits