Skip to content
Agent Orchestration
Skill

/readme-audit

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

BOOST
From plugin
loopkit
75553 skills1 agent4 commands2 MCP
Install
$ npx -y skills add Archive228/loopkit --skill readme-audit --agent claude-code

How it fires

How this skill gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
  • You can call itInvoke it directly when you want it.
  • Slash command/readme-audit

Context preview

The summary Claude sees to decide when to auto-load this skill.

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

SKILL.md

readme-audit.SKILL.md
name: readme-audit
description: Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.
when_to_use: publishing a repo, onboarding docs, "is the README good"

README Audit

A README's only job: a stranger clones it and gets to "it works" without asking you. Check, in order: 1. **One sentence** on what it is and who it's for — above the fold. 2. **Install** — copy-paste commands that actually work on a clean machine. Test them mentally step by step. 3. **Run / quickstart** — the smallest end-to-end example. 4. **Config** — required env vars, where secrets go. 5. **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.

Ships withloopkit

33 battle-tested skills + minimal .claude harness for any coding agent (Claude Code, Cursor, Codex, Gemini CLI).

Get the whole plugin

Other skills on loopkit.