See it in action

You say

Check if the README in my current directory is ready to ship to GitHub.

Your agent does

Verdict: NEEDS WORK

Passed: What & why, Stated requirements, Scannable structure.

Fix before shipping:

Missing working example: Add a 3-line code snippet showing basic API usage.
Install steps: Include the npm install command; currently only shows configuration.

About this skill

A README is the first thing anyone sees, and most fail the same few ways: they explain the internals before saying what the thing is, skip the prerequisite, or ship an example that does not run. README Quick-Check is a fast gate, not a full edit. It scores your README against seven essentials that make or break it — what-and-why up top, install steps, a working example, stated requirements, runnable commands, scannable structure, and no red flags — then returns a READY or NEEDS WORK verdict with the top things to fix, most important first. Free, evergreen, no install or dependencies. Works with Claude Code, Cursor, Codex CLI, Gemini CLI, and any SKILL.md agent. For a full editorial review across READMEs, API references, changelogs, PRDs, and docstrings with severity-ranked findings, see Docs Review Gate from the same author.