52/100

Grade D

BurntSushi/ripgrep at 91f5d22 (master) · README.md
9 checks pass, 12 fail, 7 not checked · 41.8 of 80 points

Scored as CLI tool ·Library ·Full-stack app ·Backend API

Type chosen on this page.

Fix first

FailExamples0/4.7

missing · limit: required for a library · line 519
Fix: Add "## Examples" at line 519, before "Related tools". Two or three complete examples a reader can copy and run, or links to them.
```
## Examples

Two or three complete examples a reader can copy and run, or links to them.
```
FailLicense0/4.7

missing · limit: required for a library · line 519
Fix: Add "## License" at line 519, before "Related tools". The license's name and a link to the LICENSE file.
```
## License

The license's name and a link to the LICENSE file.
```
FailTitle near the top0/4

none · limit: within 5 non-empty lines
Fix: Add a title as the first line: "# ripgrep: what it does, in one line".
FailInstall command0/4

line 246 · limit: within 40 lines · line 246
Fix: Move the install command at line 246 (brew install ripgrep) into the first 40 lines, under the pitch.
FailPicture of it working0/4

line 36 · limit: within 20 lines; badges do not count · line 36
Fix: Move the image at line 36 into the first 20 lines.

Sections 12.8/35

FailOverview0/3.2

missing · limit: recommended for a library · line 1
Fix: Add "## What is ripgrep?" at line 1, before "ripgrep (rg)". Two or three sentences: what ripgrep does, who it is for, and what it replaces.
```
## What is ripgrep?

Two or three sentences: what ripgrep does, who it is for, and what it replaces.
```
PassKey features3.2/3.2

"Why should I use ripgrep?" · limit: recommended for a library · line 116
FailPrerequisites0/1.6

missing · limit: nice to have for a library · line 161
Fix: Add "## Prerequisites" at line 161, before "Why shouldn't I use ripgrep?". What to install first, with versions (Node.js 22+, Docker), and a command that checks each one.
```
## Prerequisites

What to install first, with versions (Node.js 22+, Docker), and a command that checks each one.
```
PassInstallation4.8/4.8

"Installation" · limit: required for a library · line 233
PassUsage or commands4.8/4.8

"Running tests" · limit: required for a library · line 507
FailConfiguration0/1.6

missing · limit: nice to have for a library · line 519
Fix: Add "## Configuration" at line 519, before "Related tools". Every setting in a table: name, default, what it changes. Environment variables and config files both.
```
## Configuration

Every setting in a table: name, default, what it changes. Environment variables and config files both.
```
FailExamples0/4.7

missing · limit: required for a library · line 519
Fix: Add "## Examples" at line 519, before "Related tools". Two or three complete examples a reader can copy and run, or links to them.
```
## Examples

Two or three complete examples a reader can copy and run, or links to them.
```
FailTroubleshooting0/1.6

missing · limit: nice to have for a library · line 519
Fix: Add "## Troubleshooting" at line 519, before "Related tools". The three errors people hit most, each with the message they see and the fix.
```
## Troubleshooting

The three errors people hit most, each with the message they see and the fix.
```
FailRoadmap0/1.6

missing · limit: nice to have for a library · line 519
Fix: Add "## Roadmap" at line 519, before "Related tools". What is planned next and what is out of scope, or a link to the issues or project board that tracks it.
```
## Roadmap

What is planned next and what is out of scope, or a link to the issues or project board that tracks it.
```
FailContributing0/3.2

missing · limit: recommended for a library · line 519
Fix: Add "## Contributing" at line 519, before "Related tools". How to run the tests and open a pull request, or a link to CONTRIBUTING.md.
```
## Contributing

How to run the tests and open a pull request, or a link to CONTRIBUTING.md.
```
FailLicense0/4.7

missing · limit: required for a library · line 519
Fix: Add "## License" at line 519, before "Related tools". The license's name and a link to the LICENSE file.
```
## License

The license's name and a link to the LICENSE file.
```

First screen 4/20

FailTitle near the top0/4

none · limit: within 5 non-empty lines
Fix: Add a title as the first line: "# ripgrep: what it does, in one line".
FailInstall command0/4

line 246 · limit: within 40 lines · line 246
Fix: Move the install command at line 246 (brew install ripgrep) into the first 40 lines, under the pitch.
FailPicture of it working0/4

line 36 · limit: within 20 lines; badges do not count · line 36
Fix: Move the image at line 36 into the first 20 lines.
PassBadges before the first code block4/4

3 · limit: at most 6 · line 11
FailWords before the first code block0/4

1447 · limit: at most 250 · line 245
Fix: Cut 1197 words before the first code block at line 245, or move that block up.

Readability 10/10

PassFlesch reading ease10/10

62.2 (0% infrastructure words) · limit: 60+ for full points, 30 or below for none

Quickstart 5/5

PassQuickstart block2/2

line 246 · limit: a shell block that installs the project · line 246
PassCommands in the quickstart3/3

1 command · limit: at most 6; a && b is two · line 246
- line 246: brew install ripgrep
Not checkedTranslations give the same commands–

no translated READMEs · limit: 0; folder names may be translated

Links 10/10

PassRelative links resolve5/5

0 of 13 links broken · limit: 0 broken; 1 point off for each
Pass#anchors match a heading5/5

0 of 3 anchors broken · limit: 0 broken; 1 point off for each

Tagline not checked

Not checkedOne tagline everywhere–

1 source: nothing to compare · limit: 1; points by wordings: 3, 1.5, 0
Fix: Use one wording everywhere. The most used is "ripgrep recursively searches directories for a regex pattern while respecting your gitignore"; change .
- README.md H1: (none)
- Cargo.toml:5: Cargo.toml description: (none)
- A: GitHub About description: "ripgrep recursively searches directories for a regex pattern while respecting your gitignore"
Not checkedOne spelling of the name–

the README has no H1 to take the name from · limit: the H1's spelling

Website not checked

Not checkedWebsite headline matches the README–

no website: set the repository's homepage on GitHub (the gear next to About) or "homepage" in package.json · limit: the README H1's wording
Not checkedWebsite description matches the README pitch–

no website: set the repository's homepage on GitHub (the gear next to About) or "homepage" in package.json · limit: 50% of the website's key words
Not checkedWebsite leads with the README's command–

no website: set the repository's homepage on GitHub (the gear next to About) or "homepage" in package.json · limit: the first <name> command the README's quickstart runs
Not checkedWebsite shows the README's install command–

no website: set the repository's homepage on GitHub (the gear next to About) or "homepage" in package.json · limit: the README's first install command

Badge, API and MCP

[![README score](https://readme.flisk.si/badge/BurntSushi/ripgrep.svg)](https://readme.flisk.si/BurntSushi/ripgrep)
curl 'https://readme.flisk.si/api/score?repo=BurntSushi/ripgrep'
claude mcp add --transport http readme-score https://readme.flisk.si/mcp

Score another

Or paste a README