README missing usage instructions
Part of Documentation, UX & Accessibility, which counts for 15% of the overall score. When this check fires it deducts 4 points from that category, once per scan, no matter how many places it turns up.
What it detects
The README doesn't appear to include a usage/example section.
Why it matters
Setup gets someone to a running process, but without a usage section they still do not know what to do with it: which URL to open, which command to invoke, what a typical call looks like. For a CLI or library this is the difference between someone adopting it and closing the tab. One concrete example answers most first questions.
How to fix it
Add a "Usage" section to README.md with at least one real, copy-pasteable example: the URL to open after starting the dev server for a web app, an example invocation with real flags and its output for a CLI, or a minimal import-and-call snippet for a library. Show actual expected output where it is short enough, so people can confirm it worked.
The paid report includes a ready-to-paste prompt for your AI coding agent for every check it finds, pointed at the exact findings from your scan. See pricing
Does your repo trip this check?
Paste a GitHub URL or drop a project folder. Scans run in your browser and take seconds.
Scan your repo