Goblin-mode doc-update-readme-gamma

Name: doc-update-readme-gamma
Author: JasonWarrenUK

{{ ƔƔƔ }} Update a README to reflect recent changes

install

source · Clone the upstream repo

git clone https://github.com/JasonWarrenUK/goblin-mode

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/JasonWarrenUK/goblin-mode "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/doc-update-readme-gamma" ~/.claude/skills/jasonwarrenuk-goblin-mode-doc-update-readme-gamma && rm -rf "$T"

manifest: skills/doc-update-readme-gamma/SKILL.md

source content

Update the README.md in the specified directory (or the project root if none given).

Target directory:

$ARGUMENTS

If no argument was provided, default to

./README.md

Steps

Resolve the target: if an argument was given, look for
```
README.md
```
in that directory; otherwise use
```
./README.md
```
If the README doesn't exist, stop and suggest using
```
/doc:create:readme:for
```
instead
Read the existing README to understand its structure and style
Review recent changes in the target directory:
- ```
git log -15 --oneline -- <directory>
```
- ```
git diff HEAD~15 -- <directory>
```
  (or fewer commits if the directory has less history)
- Check for new, renamed, or deleted files
Identify what needs updating:
- Outdated descriptions or references
- New features, files, or modules not yet documented
- Removed content that should be cleaned up
- Structural changes (renamed sections, reorganised files)
Generate targeted updates preserving the existing structure and style; show a diff
Apply on approval

Notes

Match the existing README's tone and formatting
Don't remove content unless it's genuinely obsolete
Prefer surgical updates over full rewrites
If changes are minor, say so — don't invent updates for the sake of it