README checker
Enter a public GitHub repository and get a score out of 100 with a list of what to fix. No sign-in, nothing stored.
What it checks
How to write a good README
What it is, in the first lines
One or two sentences that say what the project does and who it is for, before badges and logos.
Proof it works
A screenshot, GIF or video near the top. People decide whether to keep reading in seconds.
Install in one step
A section with the single command that installs it from the package registry.
A real example
A short code example someone can paste and run, under a Usage heading.
A licence
Without a licence nobody can legally use the code. GitHub reads it from your LICENSE file.
Where to go next
How to contribute, and headings that let people jump to what they need.
FAQ
Questions about READMEs
What makes a good README?
A good README says what the project is in its first lines, shows it working, installs in one command, gives a copy-pasteable example, states the licence and explains how to contribute. Everything else is detail.
How is the score calculated?
Each check has a weight, with the basics (a README existing, install steps and a usage example) counting most. The score is the share of those weights your README passes. It checks structure, not whether the writing is good.
Does it work on private repositories?
No. It reads public repositories through the GitHub API and stores nothing about them.
Launching soon? List your tool on TeaserTrack
A free listing with your launch date, reviewed by a person, in front of developers looking for what is new.
Related guide: How to write a README that converts