# update-readme

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.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 276 repo stars
- Author: Samarth Gupta
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/gupsammy/Claudest/tree/HEAD/plugins/claude-coding/skills/update-readme/SKILL.md
- Updated: 2026-10-29
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/update-readme

## What it 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.

## Install

### Claude Code (native platform)

1. **Plugin marketplace**
In the agent chat (not a shell):
```text
/plugin marketplace add gupsammy/Claudest
```
In the agent chat (not a shell):
```text
/plugin install claude-coding@Claudest
```
This installs the whole claude-coding plugin with all its skills

2. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a claude-code
```

3. **Manually: put the files in place**
- File: `~/.claude/skills/update-readme/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/update-readme/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/update-readme/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/update-readme/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install gupsammy/Claudest plugins/claude-coding/skills/update-readme
```

2. **Manually: put the files in place**
- File: `.github/skills/update-readme/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add gupsammy/Claudest --skill update-readme -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/gupsammy/Claudest --path plugins/claude-coding/skills/update-readme
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/update-readme/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/gupsammy/Claudest/tree/HEAD/plugins/claude-coding/skills/update-readme/SKILL.md

## When to use it
- 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
- 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

## Similar
- [readme-generator](https://affpapa.org/en/nevibecode/agents/readme-generator.md) — subagent · ★ 26718 repo stars
- [readme-updater](https://affpapa.org/en/nevibecode/skills/readme-updater.md) — skill · ★ 788 repo stars
- [readme-blueprint-generator](https://affpapa.org/en/nevibecode/skills/readme-blueprint-generator.md) — skill · 9662 installs
- [indexion-readme](https://affpapa.org/en/nevibecode/skills/indexion-readme.md) — skill · 5100 installs
- [docs-updater](https://affpapa.org/en/nevibecode/skills/docs-updater.md) — skill · 3700 installs
- [update-docs-on-code-change](https://affpapa.org/en/nevibecode/rules/update-docs-on-code-change.md) — rule · ★ 41430 repo stars

From the same set: [gupsammy/claudest](https://affpapa.org/en/nevibecode/by/gupsammy/claudest.md) — 47 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
