# badges/shields

Concise, consistent, and legible badges in SVG and raster format

Repository: https://github.com/badges/shields
Canonical: https://ross.abutalabs.com/products/shields
Homepage: https://shields.io
Language: JavaScript
License: Apache-2.0
License Family: permissive
Topics: badge, github, svg, status, metadata, badge-maker, hacktoberfest
Last push: 2026-08-21T21:48:56+00:00

## Health v2 (maintenance only)
Score: 76/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 98, release rhythm 35, longevity 100
- inputs: {"age_days": 4963, "days_push": 12, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 27120, forks 5620 (observed 2026-08-28T04:11:47.400897+00:00)

## What it is
Shields.io is a service that generates concise, consistent, and legible project badges in SVG and raster formats for inclusion in GitHub readmes and web pages, supporting hundreds of services like CI systems, package registries, and code coverage tools. The repo also includes a badge-maker NPM library and a Docker image for self-hosting the badge service.

## Use cases
- add version and build status badges to a github readme
- show code coverage percentage badge in my project docs
- generate svg badges for npm package downloads
- self-host a badge service behind a firewall
- generate badges programmatically in node with an npm library
- create custom static badges with custom colors and labels

## When to choose
- you want polished, consistent status badges for open-source project readmes
- you need badges for many services (CI, coverage, registries, social) from one provider
- you want to render badges in your own app via the badge-maker npm package
- you need a self-hosted badge server via Docker

## When to avoid
- you need rich data visualizations or charts rather than small status badges
- you want fully offline badge generation without any library or service
- you need animated or highly interactive graphics

## Facets
- artifact type: service
- maturity: stable
- function: image-processing, developer-tools, documentation, sdk
- domain: developer-tools, web-development, documentation, self-hosted
- platform: self-hosted, cli
- tags: badges, svg, shields-io, readme, github, status-indicators, badge-maker, nodejs, web-server, docker

## Member repositories
- badges/shields (main) score 76

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:11:47.400897+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T16:54:35.299973+00:00, confidence not recorded.
  - readme: https://github.com/badges/shields (fetched 2026-08-28T04:11:47.400897+00:00, sha 7e1f6a1dadf4)
  - homepage: https://shields.io (fetched 2026-08-29T07:52:11.613935+00:00, sha 1c8429a5dfcb)
  - site_page: https://shields.io/docs (fetched 2026-08-29T07:52:11.623028+00:00, sha 04916ff978cb)
- Data as of 2026-08-30T08:39:29.467469+00:00.