GitDEXGitDEX
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

Example:

https://gitdex.app/badge/z6MkqDnb7Siv3Cwj7pGJq4T5EsUisECqR8KpnDLwcaZq5TPr/openclaude.svg

Markdown snippet

For a README:

[![GitScore](https://gitdex.app/badge/z6MkqDnb7Siv3Cwj7pGJq4T5EsUisECqR8KpnDLwcaZq5TPr/openclaude.svg)](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):

ScoreColor
≥80emerald
60–79lime
40–59amber
<40zinc

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

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