Repolode
Submit
badges

badges/shields

Shields.io is a service and NPM library that generates concise SVG and raster status badges for README files and web pages.

View on GitHubWebsite
Stars
27,368
Forks
5,629
Open issues
295
Last commit
13 hours ago

What is it?

Shields.io produces consistent, legible badges that show status, versions, downloads, coverage, and similar metrics. A badge is created by pointing a URL at a data source such as a CI service, package registry, app store, or code analysis tool, and the image can be embedded in GitHub READMEs or any other web page. The service covers dozens of continuous integration services, package registries, distributions, social networks, and code quality tools.

This repository contains the Shields.io frontend and server code, the badge-maker NPM library for generating badges programmatically, and the badge design specification. Developers can also write custom badges with a static URL that sets a label, message, and color, or self-host the server with optional Sentry and Prometheus integration.

The project is maintained by a community of contributors and is built on Node.js with Docusaurus for its documentation site.

Key features

  • 01Generates SVG and raster badges from a URL with no account needed
  • 02Covers many CI services, package registries, app stores, and code analysis tools
  • 03Provides the badge-maker NPM library for generating badges in code
  • 04Includes a custom static badge option for arbitrary labels and colors
  • 05Can be self-hosted with optional Sentry and Prometheus support

Use cases

  • Adding build, coverage, and version badges to a GitHub README
  • Showing package download counts or release versions on a project homepage
  • Generating badges programmatically in a Node.js build script with badge-maker
  • Hosting a private badge server for an internal organization

Quick start

  1. 1

    Install Node 24 using your preferred package manager

  2. 2

    Clone this repository

  3. 3

    Install the dependencies

    npm ci
  4. 4

    Start the badge server and frontend dev server, then open http://localhost:3000/

    npm start

Things to know

  • Development setup requires Node 24 and a full repository clone.

Topics

#badge#svg#status-badge#ci#readme#nodejs#badge-generator#badge-maker#github#hacktoberfest

FAQ

What is shields?
Shields.io is a service and NPM library that generates concise SVG and raster status badges for README files and web pages. Shields.io produces consistent, legible badges that show status, versions, downloads, coverage, and similar metrics. A badge is created by pointing a URL at a data source such as a CI service, package registry, app store, or code analysis tool, and the image can be embedded in GitHub READMEs or any other web page. The service covers dozens of continuous integration services, package registries, distributions, social networks, and code quality tools.
Is shields free to use? What license does it have?
shields is open source under the Apache-2.0 license. Check the license terms before using it in commercial products.
Is shields still maintained?
Actively maintained. The last commit to shields was on Nov 7, 2026.
What can I use shields for?
Adding build, coverage, and version badges to a GitHub README Showing package download counts or release versions on a project homepage Generating badges programmatically in a Node.js build script with badge-maker Hosting a private badge server for an internal organization
How do I install shields?
Install Node 24 using your preferred package manager Clone this repository Install the dependencies: npm ci Start the badge server and frontend dev server, then open http://localhost:3000/: npm start
Where can I get shields?
The source code and installation instructions are on GitHub: https://github.com/badges/shields

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects