Skip to main content
skill CX Codex

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

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add gupsammy/Claudest
/plugin install claude-coding@Claudest
Open on GitHub

What 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_USERNAME and TODO placeholders
  • 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@Claudest

This installs the whole claude-coding plugin with all its skills

2Skills CLI (Vercel)

npx skills add gupsammy/Claudest --skill update-readme -a claude-code

3Manually: put the files in place

~/.claude/skills/update-readme/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/update-readme/

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.

Similar skills

All skills for Writing and docs →

From the same set47

The whole set →
memory-auditor The memory-auditor subagent for Claude Code checks memory against code and Git, flagging stale or duplicate entries. Run it after a major refactor. CX Codex ★ 276repo stars clean-branches clean-branches is a Claude Code skill that finds merged and stale git branches, marks protected ones, and asks before deletion. It helps clear accumulated branch clutter. CX Codex +1 ★ 276repo stars council council launches parallel personas to deliberate on technical questions, examine codebase files, and formulate an opinionated verdict. CX Codex +1 ★ 276repo stars claw-advisor claw-advisor is a Claude Code skill for OpenClaw setup, troubleshooting, and architecture questions. It handles requests about channels, gateways, models, and automation. CX Codex +1 ★ 276repo stars architecture-auditor architecture-auditor reviews system structure, detects circular dependencies, and suggests design patterns when features touch multiple modules. CX Codex ★ 276repo stars make-changelog make-changelog creates or updates CHANGELOG.md from Git history in Keep a Changelog format. Use it when preparing release notes or catching up on missing entries. CX Codex +1 ★ 276repo stars recall-conversations recall-conversations reads back your earlier Claude sessions: finds a decision, restores context, or builds a retro from the local conversation database. CX Codex +1 ★ 276repo stars make-readme make-readme inspects repository context, runs a brief questionnaire, and builds a complete README.md with status badges. CX Codex +1 ★ 276repo stars

Project sponsors

Companies that keep this analytics open