Put a badge on your README
Three images, one address each. They report the latest public scan of a repository and need nothing installed.
The snippet #
Replace OWNER and REPO with your own. The badge links back to the repository's page, so a reader who wants the detail behind the letter has one click to it.
[](https://skilltrust.app/r/OWNER/REPO)
The three images #
| Address | Shape | Use it for |
|---|---|---|
| /badge/OWNER/REPO/pill.svg | One small pill | A README badge row. |
| /badge/OWNER/REPO/card.svg | A wider card with the axes | A README header, or a docs page. |
| /badge/OWNER/REPO/og.png | A social preview image | An og:image meta tag. |
What a badge needs before it says anything #
A badge reads the latest public scan of that repository. A repository nobody has scanned, and a repository whose scan has not been shared, both get the grey unscanned badge rather than an error.
So the sequence is: scan the repository, share the result, then add the snippet. An unscanned badge on a README is not a failure state — it is the badge telling the truth about what it can see.
Badges are addressed by owner and repository, so they exist for the repository check only. Checking a single skill produces the same report, and you can share that report's link, but there is no address a badge could be served from — scan the repository the skill lives in when you want one.
When it catches up #
A badge is cached for 5 minutes in the reader's browser, and longer in shared caches, GitHub's image proxy among them. A new scan therefore shows up on your README a few minutes after it finishes, not instantly.