Documentation menu▾
Tools
Embed badge
A shields.io-style SVG badge that shows your repo's current GitScore live. Paste it into your README — the badge fetches the latest score on every page load, cached 1 hour at the edge.
URL pattern
https://gitdex.app/badge/{ownerKeyFragment}/{repoName}.svg
ownerKeyFragment— the part afterdid:key:in your owner DIDrepoName— your repo name as indexed by gitlawb
Example:
https://gitdex.app/badge/z6MkqDnb7Siv3Cwj7pGJq4T5EsUisECqR8KpnDLwcaZq5TPr/openclaude.svg
Markdown snippet
For a README:
[](https://gitdex.app)
Renders as a small badge that links to gitdex.app when clicked.
Color coding
The score field is tinted by tier (same as the web app):
| Score | Color |
|---|---|
| ≥80 | emerald |
| 60–79 | lime |
| 40–59 | amber |
<40 | zinc |
If the repo isn't in our index (or you mistyped the path), the badge renders with — in muted zinc — it won't break your README, it just shows "not indexed yet."
Caching
- 1-hour CDN cache (
s-maxage=3600) - 24-hour stale-while-revalidate
- Updates within ~1 hour after the daily indexer cron refreshes scores
So your README badge stays fresh without re-deploying. The trade-off is that score changes take up to an hour to propagate.
See also
- GitScore methodology — what the badge number actually means
- gitscore CLI — same score, in your terminal