Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

shieldcn

Before anyone reaches your docs, they land on your README, the front door of every open-source project. shieldcn makes that first impression count: badges, charts, headers, and sponsor walls, rendered as real shadcn/ui components. A shields.io alternative.

shieldcn stats

Vercel OSS Program Member analytics by openpanel Powered by Neon

Usage

Drop a badge into any README and it renders as a real shadcn Button.

![npm](https://shieldcn.dev/npm/react.svg)
![stars](https://shieldcn.dev/github/vercel/next.js/stars.svg)
![views](https://shieldcn.dev/views/repo/shieldcn/shieldcn.svg)

Agent skill

Install the shieldcn-badges skill from skills.sh so your coding agent can add shieldcn badges, charts, and headers to READMEs:

npx skills add jal-co/shieldcn -a claude-code # installs to Claude Code
npx skills add jal-co/shieldcn -a cursor # installs to Cursor

See skills/shieldcn-badges/SKILL.md for prompt examples and options.

Star history

Hosted star charts use GitHub's privacy-safe weekly history API. Embed https://shieldcn.dev/chart/github/stars/{owner}/{repo}.svg for any public repository, or use .png and .json at the same path.

To commit a light/dark SVG pair to your repo, use the shieldcn starchart GitHub Action:

- uses: jal-co/shieldcn@v1
  with:
    theme: violet
    pull-request: true

PR mode needs contents: write, pull-requests: write, and permission for Actions to create pull requests in repository settings.

GitHub Action docs → · action reference

Star history of jal-co/shieldcn

Sponsors

sponsors

Contributors

contributors

MIT · Built by Justin Levine · Contribute

About

Beautiful README badges, inspired by shields.io and styled like shadcn/ui.

Topics

Resources

Code of conduct

Contributing

Stars

884 stars

Watchers

2 watching

Forks

Sponsor this project

Packages

Used by

Contributors

Languages