tanmayai23/README-Editor-skill

 
Why · Quickstart · How it works · Scripts · CI · Trust · Limitations · Design · FAQ · Support
bash
claude plugin install readme-forge --marketplace tanmayai23/README-Editor-skill
## Why
A README generator that guesses is worse than none: a wrong install command costs a new user more than a missing one. readme-forge reads the repo first, writes only what it can point to in a file, and leaves a TODO where it can't. Then verifyreadme.py checks the result claim by claim.
This is its real output on a test fixture: a pnpm app whose README was seeded with five mistakes.
text
$ python readme-forge/scripts/verifyreadme.py README.bad.md --repo tests/fixtures/verify/node-app
✓ 6 command npm install [package.json exists]
✗ 6 packagemanager npm [repo uses pnpm (pnpm-lock.yaml), not npm]
✗ 7 script pnpm run deploy [no 'deploy' script in package.json (scripts: dev, test)]
✓ 7 packagemanager pnpm [pnpm-lock.yaml matches pnpm]
✗ 8 envvar REDISURL [not referenced in any code, config or .env file]
✗ 9 command docker compose up worker [no service worker in docker-compose.yml (services: api, db)]
✗ 12 path docs/setup.md [no docs/setup.md in the repo]
claims: 7 checked · 2 verified · 5 not found · 0 unverifiable · 1 generic · accuracy 28.6%
> [!IMPORTANT]
> Every ✗ is something the README says that the code doesn't have. The skill doesn't finish until there are none.
## Quickstart
Install the skill once from any terminal. It then works in every project:
bash
claude plugin install readme-forge --marketplace tanmayai23/README-Editor-skill
Then, in Claude Code:
text
/readme-forge write a README for this repo
You can also just say "improve my README" or "is my README accurate?". From a script: claude -p "/readme-forge audit README.md and fix every error".
claude.ai or Claude Desktop: download readme-forge.zip from the latest release and upload it under Settings → Capabilities → Skills.
Older Claude Code, project-only install, updating, or manual install
Older versions add the marketplace first:
bash
claude plugin marketplace add tanmayai23/README-Editor-skill
claude plugin install readme-forge@readme-forge
Add --scope project to install for one project and share it with your team. Update with claude plugin marketplace update readme-forge, then claude plugin update readme-forge@readme-forge. To install by hand, copy the readme-forge folder to ~/.claude/skills/readme-forge.
### Try it without Claude
The scripts run on their own as a free README linter and fact checker. Run them on the sample app in this repo:
bash
git clone https://github.com/tanmayai23/README-Editor-skill.git
cd README-Editor-skill
python readme-forge/scripts/verifyreadme.py demo/sample-app/README.after.md --repo demo/sample-app # 12 of 12 claims match
python readme-forge/scripts/scorereadme.py demo/sample-app/README.before.md --repo demo/sample-app # 43/100, grade F
python readme-forge/scripts/scorereadme.py demo/sample-app/README.after.md --repo demo/sample-app # 95/100, grade A
Watch the demo (a 43/100 README rewritten by one command)
Full 34-second demo in HD . The scorer is this repo's own, so treat the score as a checklist, not proof; the claim check is the part you can audit line by line.