Guides
README Badge
Add a quality score badge to your GitHub README. The badge shows the ToolCairn quality score and is automatically updated whenever your tool is re-indexed.
Quick Start
Replace owner and repo with your GitHub repository details.
Examples
How it Works
- 1.The badge URL hits the ToolCairn API and looks up your repo by GitHub URL.
- 2.If indexed, it returns an SVG with the current quality score, color-coded by tier.
- 3.If not indexed, it returns a grey "not indexed" badge with a link to submit your repo.
- 4.Badges are cached for 1 hour by Cloudflare's edge network.
Not Indexed?
If your repo shows "not indexed", submit it for indexing and the badge will update automatically once it's processed (usually within 24 hours).