shields README

The project's README from github.com/badges/shields. As one markdown file: README.md.

Daily Tests Status Code Coverage Chat on Discord

This is home to Shields.io, a service for concise, consistent, and legible badges in SVG and raster format, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. Every month it serves over 1.6 billion images and is used by some of the world's most popular open-source projects, VS Code, Vue.js and Bootstrap to name a few.

This repo hosts:

Examples

Make your own badges! (Quick example: https://img.shields.io/badge/left-right-f39f37)

Quickstart

Browse a complete list of badges and locate a particular badge by using the search bar or by browsing the categories. Click on the badge to fill in required data elements for that badge type (like your username or repo) and optionally customize (label, colors etc.). And it's ready for use!

Use the button at the bottom to copy your badge url or snippet, which can then be added to places like your GitHub readme files or other web pages.

Contributing

Shields is a community project. We invite your participation through issues and pull requests! You can peruse the contributing guidelines.

When adding or changing a service please add tests.

This project has quite a backlog of suggestions! If you're new to the project, maybe you'd like to open a pull request to address one of them.

You can read a tutorial on how to add a badge.

GitHub issues by-label

If you intend on reporting or contributing a fix related to security vulnerabilities, please first refer to our security policy.

Development

Open in GitHub Codespaces

  1. Install Node 24. You can use the package manager of your choice.
  2. Clone this repository.
  3. Run npm ci to install the dependencies.
  4. Run npm start to start the badge server and the frontend dev server.
  5. Open http://localhost:3000/ to view the frontend.

When server source files change, the badge server should automatically restart itself (using nodemon). When the frontend files change, the frontend dev server (docusaurus start) should also automatically reload. However the badge definitions are built only before the server first starts. To regenerate those, either run npm run prestart or manually restart the server.

To debug a badge from the command line, run npm run badge -- /npm/v/nock. It also works with full URLs like npm run badge -- https://img.shields.io/npm/v/nock.

Use npm run debug:server to start server in debug mode. This recipe shows how to debug Node.js application in VS Code.

Snapshot tests ensure we don't inadvertently make changes that affect the SVG or JSON output. When deliberately changing the output, run SNAPSHOT_DRY=1 npm run test:package to preview changes to the saved snapshots, and SNAPSHOT_UPDATE=1 npm run test:package to update them.

The server can be configured to use Sentry (configuration) and Prometheus (configuration).

Our full test suite as well as code coverage are run on a daily basis.

Hosting your own server

There is documentation about hosting your own server.

Awesome

Status badges are used widely across open-source and private software projects. Academics have studied the "signal" badges provide about software project quality. There are many existing libraries for rendering these badges, and alternatives to the hosted Shields badge service. awesome-badges is a curated collection of such resources. Contributions may be considered there. (The presence of a project in that collection should not be interpreted as an endorsement nor promotion from the Shields project)

History

b.adge.me was the original website for this service. Heroku back then had a thing which made it hard to use a toplevel domain with it, hence the odd domain. It used code developed in 2013 from a library called gh-badges, both developed by Thaddée Tyl. The project merged with shields.io by making it use the b.adge.me code and closed b.adge.me.

The original badge specification was developed in 2013 by Olivier Lacan. It was inspired by the Travis CI and similar badges (there were a lot fewer, back then). In 2014 Thaddée Tyl redesigned it with help from a Travis CI employee and convinced everyone to switch to it. The old design is what today is called the plastic style; the new one is the flat style.

You can read more about the project's inception, the motivation of the SVG badge specification, and the specification itself.

Project leaders

Maintainers:

Alumni:

License

Shields.io is dual licensed and distributed under the terms of both the MIT license and the Apache license (Version 2.0).

Community

Thanks to the people and companies who donate money, services or time to keep the project running. https://shields.io/community

shields (badges/shields)

Searching Database…

27.3K ·GitHub
Shields
Что это такое?Shields.io — сервис коротких, единообразных и читаемых бейджей в SVG и растровых форматах, созданный для вставки в GitHub-README или на любую другую веб-страницу.
Это готовый сайт, npm-библиотека или что-то, что я запускаю сам?И то, и другое, и третье: hosted-сервис на shields.io, код сервера и фронтенда в этом репозитории, а также npm-библиотека badge-maker для генерации бейджей из кода. Сервер можно развернуть и у себя.
Как на самом деле добавить бейдж в свой проект?Найдите нужный бейдж в списке на shields.io, кликните по нему, заполните данные вроде своего username или репозитория, при желании поменяйте подпись и цвета, а затем скопируйте ссылку или сниппет в свой README.
Что мне нужно, чтобы работать с кодом?Node 24 (engines допускает также 26): склонируйте репозиторий, выполните npm ci, затем npm start — поднимутся сервер бейджей и dev-сервер фронтенда; nodemon автоматически перезапускает сервер при изменениях.
Есть ли подводные камни при запуске dev-сервера?Определения бейджей собираются только перед первым запуском сервера, поэтому после их изменения нужно выполнить npm run prestart или перезапустить сервер. Сервер и фронтенд перезагружаются на лету, а определения — нет.
Могу ли я поднять свой сервер бейджей вместо того, чтобы полагаться на shields.io?Да — в репозитории есть документация по запуску собственного сервера, а в CI настроена сборка Docker-образа. Самостоятельно размещённый сервер при желании может отправлять данные в Sentry и Prometheus.
Что вообще может показывать бейдж?Десятки источников: сервисы непрерывной интеграции, пакетные реестры, магазины приложений, социальные сети, инструменты для проверки покрытия кода и его анализа. Например, процент покрытия, версия релиза, состояние зависимостей, недельные пожертвования на Liberapay, загрузки Python-пакета, рейтинг Chrome-расширения и аптайм.
Насколько он распространён?Он отдаёт более 1,6 миллиарда изображений бейджей в месяц, и им пользуются одни из самых популярных open-source-проектов в мире, включая VS Code, Vue.js и Bootstrap.
Зачем нужен npm-пакет badge-maker?Это npm-библиотека из этого же репозитория, которая позволяет генерировать бейджи того же стиля программно из своего кода; к ней прилагаются собственная документация и changelog.
Откуда взялся Shields?Всё началось в 2013 году с библиотеки gh-badges и сайта со странным названием b.adge.me — оба проекта создал Thaddee Tyl. Исходную спецификацию бейджей от Olivier Lacan вдохновили бейджи Travis CI; позже эти проекты объединились в shields.io, а старый дизайн сохранился как стиль plastic.
What are similar projects?skill-icons, github-readme-stats, Badges4-README.md-Profile, gatus, anthropies, metrics, markdown-badges, redoc
Which topics is it in?badges, status, badge, metadata, svg, github, hacktoberfest, free, npm, api, tool, apache-2.0
Creator
badges
Size
517.6 MB
Stars
27.3K
Updated
CommitOct 12
Age
13y
Commits · 90 Days