update-readme — Claude Code skill: refresh README from code and git
update-readme rewrites an existing README.md using the current code, git log and changelog. Useful once the docs drift away from what the repo actually does.
no license ★ 276 updated 2026-10-29
/plugin marketplace add gupsammy/Claudest
/plugin install claude-coding@ClaudestWhat update-readme does
The skill walks an existing README.md through a fixed routine instead of regenerating it. First it runs claude-coding:make-changelog so the changelog is current, then sends three Explore subagents out in one message: one audits every heading for stale versions, broken paths and unfilled placeholders, one reads the manifest and directory layout, one collects commits made since the README last changed.
Edits land in priority order. Version numbers and shields.io badges come first, then stale paths and placeholders, then new features pulled from commits and the latest changelog block; missing sections such as installation or API come last. Small fixes go through Edit to keep git blame intact. Write is reserved for runs where most of the file changes.
Git history is the hard dependency. With no commits, make-changelog reports an error and the run continues without changelog context, so the Features section rests on the codebase scan alone. A README holding fewer than 5 lines of real content gets handed to claude-coding:make-readme, and the update stops there.
What it helps with
- bump the version and shields.io badges to match the manifest
- strip leftover
YOUR_USERNAMEandTODOplaceholders - fix paths and commands broken by a rename
- add the installation and API sections a README never had
- turn commits since the last README edit into a feature list
Example prompts for the agent
- Update the README, it's out of date with the codebase
- Sync README with the current code and git history
- Refresh the README and bump the version
How to install update-readme
1Plugin marketplace
/plugin marketplace add gupsammy/Claudest/plugin install claude-coding@ClaudestThis installs the whole claude-coding plugin with all its skills
2Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill update-readme -a claude-code3Manually: put the files in place
~/.claude/skills/update-readme/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/update-readme/
1Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill update-readme -a codex2Manually: put the files in place
.agents/skills/update-readme/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill update-readme -a cursor2Manually: put the files in place
.cursor/skills/update-readme/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install gupsammy/Claudest plugins/claude-coding/skills/update-readme2Manually: put the files in place
.github/skills/update-readme/SKILL.md1Skills CLI (Vercel)
npx skills add gupsammy/Claudest --skill update-readme -a gemini-cli2Platform CLI
gemini skills install https://github.com/gupsammy/Claudest --path plugins/claude-coding/skills/update-readmeManually: put the files in place
.devin/skills/update-readme/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about update-readme
How do I install update-readme in Claude Code?
From the marketplace: run /plugin marketplace add gupsammy/Claudest, then /plugin install claude-coding@Claudest.
What does update-readme do?
It refreshes an existing README.md: fixes versions, paths and placeholders, adds sections that are missing, drawing on the code, git log and CHANGELOG.md.
Does it need git history?
Yes. Without it make-changelog reports an error and the skill keeps going without changelog data, leaving the Features section built from the codebase scan only.