README Audit

SkillDev tools

Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.

Available today. Use it from your connected AI after setup.

No other account needed.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the README Audit skill

What this skill tells your AI

The instructions your AI receives, as published by archive228/loopkit in skills/readme-audit/SKILL.md and read by ahel’s review.

A README's only job: a stranger clones it and gets to "it works" without asking you. Check, in order:

One sentence on what it is and who it's for — above the fold.
Install — copy-paste commands that actually work on a clean machine. Test them mentally step by step.
Run / quickstart — the smallest end-to-end example.
Config — required env vars, where secrets go.
No rot — does it reference files/commands/flags that still exist? Stale README is worse than none. Cut: long philosophy, badges nobody reads, TODO sections. Output: the specific gaps + the fix.

Advanced