Free README checker

Paste your README and get a structure score out of 100 in your browser, with a fix for every gap. Nothing is uploaded.

What it checks

The checker looks for the parts a first-time visitor needs in the first ten seconds: a title and a one-sentence tagline, an install or quick start section with a command you can copy, a usage example, a screenshot where it makes sense, a license, and a line on how to contribute or get support. It also checks that the README is long enough to answer questions but short enough that the quick start isn't buried.

It checks structure only. It can't judge whether your writing is clear, whether the commands work, or whether a newcomer would understand the project. That's what the paid rewrite is for: you paste your README or rough notes and get a full rewrite with a tagline, quick start, usage, repo description, topics and five prioritised fixes.