Getting Started
Beautiful README badges as a service. Drop-in shields.io replacement styled as shadcn/ui buttons.
What is shieldcn?
shieldcn serves SVG badge images that look like shadcn/ui Button components — same font, border-radius, padding, and color tokens. Use them in GitHub READMEs, npm pages, docs sites, and anywhere that accepts <img> tags.
Quick start
Add a badge to your README:
That's it. No configuration, no API keys, no build step.
Badge types
| Badge | URL pattern |
|---|---|
| npm version | /npm/{package}.svg |
| npm downloads | /npm/{package}/downloads.svg |
| GitHub stars | /github/{owner}/{repo}/stars.svg |
| GitHub release | /github/{owner}/{repo}/release.svg |
| CI status | /github/{owner}/{repo}/ci.svg |
| License | /github/{owner}/{repo}/license.svg |
| Discord online | /discord/{serverId}.svg |
| Static | /badge/{label}-{message}-{color}.svg |
| Dynamic JSON | /badge/dynamic/json.svg?url=...&query=... |
Variants
Every badge supports shadcn Button variants:
Sizes
Icons
Badges auto-detect icons per provider. Override with any Simple Icons slug or Lucide icon:
Response formats
.svg— SVG image (default, for<img>tags and markdown).json— raw badge data/shields.json— shields.io-compatible endpoint
Built with
Badge components for React → jal-co/ui