About Shields.io
Shields.io is an open source service that generates clean, consistent badges for projects, such as build status, versions and download counts. You add the badge image link to a README or project page.
What it does
Shields.io creates badges from static text or from live data sources, so a dynamic badge can update on its own. It covers hundreds of services. Badges can be generated through the website, through the badge-maker npm library, or by hosting a copy of the service yourself with a Docker image. Endpoint badges can also show metrics from your own data.
Key features
- Static and dynamic badges
- Badges for hundreds of services
- Endpoint badges for your own data
- npm library for rendering badges
- Docker image for hosting your own instance
Who it's for
Shields.io suits open source maintainers and project owners who want consistent badges in a README. Companies that need to keep badge data behind a firewall can host their own copy.
Pricing and good to know
The project is open source under the Apache 2.0 license and free to use. The site asks visitors to consider donating to support the work. Self-hosting means running the Docker image yourself.
Highlights
- Creates static badges from text you choose
- Creates dynamic badges that update from live data
- Offers badges for hundreds of services
- Renders badges in your own app with an npm library
- Runs your own instance from a Docker image
