README badge
Show your score in your README
Pin an analysis, open a pull request or copy the Markdown, and readers click through to the full report.
README.md
your-lab/analysis
Add RepoReady badgePull request · README.md
A quality signal anyone can check
Seen at first glance
Readers, collaborators and reviewers see your score where they start: the README.
One click to the evidence
The badge opens the full report, with the findings behind the score.
Stays current
After improvements, re-pin a newer analysis; the link in your README stays the same.
Add it in three steps
- 01
Analyze your repository
From GitHub or a zip upload, in the web app or your coding agent.
- 02
Pin an analysis
Choose which analysis the badge shows; its report becomes public.
- 03
Add it to your README
With the GitHub App, RepoReady opens a pull request; or copy the Markdown.
The color follows the score
Each badge shows the score of the pinned analysis in the color of its category.
- Excellent85–100
- Good70–84
- Fair50–69
- Poor0–49