Your README, scored out of 100, with a fix for every miss
Enter a GitHub repo or paste a README: a score out of 100, the sections found and missing, and a fix for each miss. No AI: same README, same score.
flisk-sh/fliskhonojs/honoBurntSushi/ripgrepfastapi/fastapi
Or paste a README
● No AI · No signup · Every finding names a line
README.md of a small CLISample result
68/100C
- Sections15.2/35
- First screen16/20
- Readability10/10
- Quickstart5/5
- Links4/5
- Tagline2/2
- Website0/0
Fix first, line 12: Add "## Installation" at line 12, before "Usage". One shell block with the install command, and how to check it worked.
28checks, each pointing at a line
11sections, matched by fixed synonym lists
4project types, each with its own weights
0models: same README, same score
How it scores
Seven groups, 100 points, no judgement calls.
| Group | Points | What it looks at |
|---|---|---|
| Sections | 35 | The sections a reader looks for, weighted for your project type |
| First screen | 20 | Title, install command, a picture, few badges, a short pitch |
| Readability | 10 | Flesch reading ease of the prose |
| Quickstart | 10 | One block, few commands, translations that agree |
| Links | 10 | Relative links and #anchors that resolve |
| Tagline | 5 | One description in the README, the manifests and the GitHub About box, and one spelling of the name |
| Website | 10 | The product's website: the README's headline, its pitch's words, its first command and its install command |
A check with nothing to look at (a pasted README has no file tree) is left out, and the score is the points earned over the points that count. Every threshold is on the checks page.
Or type it
https://readme.flisk.si/flisk-sh/flisk