Skip to content
RepoReady
Sign up
Menu
Docs menu

The README badge

What the badge shows, how to add it, how it stays current, and what a visitor sees when they click it.

Last updated

The badge shows the score of one analysis you choose, and links to that report. What the badge is for covers the why; this page covers the mechanics.

What it shows

The badge carries the score of the pinned analysis, from 0 to 100, in the color of its category. The ranges are on How the score works.

Until a score exists, the badge says so instead:

  • analyzing... while the analysis is running.
  • pending when the pinned analysis has not produced a score.
  • not found after the badge has been removed.

Adding it

  1. Analyze the repository, in the web app or from your coding agent.
  2. Pin the analysis you want the badge to show. Its report becomes public, so pin one you are happy for anyone to read.
  3. Add it to your README: RepoReady opens a pull request for you, or you copy the Markdown.

The app hands you the finished line. It has this shape:

README.md
[![RepoReady](https://img.shields.io/endpoint?url=<endpoint>)](https://app.repoready.ai/shared/badges/<badge-id>)

The image comes from shields.io, which reads a small JSON document from api.repoready.ai. Copy the line from the app rather than typing it: the badge id is unique to your project.

Keeping it current

  • Improved the repository? Analyze it again and pin the newer analysis. The badge id and the line in your README stay the same.
  • A new score reaches readers within a few minutes. RepoReady allows caching for a minute, and shields.io caches the image on top of that.
  • The badge always resolves to whichever analysis is pinned now, so a README from a year ago still shows current numbers.

What visitors see

Clicking the badge opens the full report: the score, every finding with its severity and evidence, and the suggested fixes. No account is needed.

  • Only the pinned analysis is public. Other analyses, other projects and your account stay private.
  • Public report pages are not indexed by search engines; they are reachable to anyone with the link.
  • Data handling covers who can see what in detail.

Removing it

  • Unpin the badge in the web app. The URL stops resolving immediately and the report is private again.
  • Anywhere the badge is still embedded then shows the shields.io fallback image, so delete the line from your README too.