badges/shields

Что это?

Ключевые возможности

• 01Создает SVG- и растровые бейджи по URL без необходимости регистрировать аккаунт
• 02Поддерживает множество CI-сервисов, реестров пакетов, магазинов приложений и инструментов анализа кода
• 03Предоставляет NPM-библиотеку badge-maker для генерации бейджей в коде
• 04Позволяет создавать статические бейджи с произвольными названиями и цветами
• 05Поддерживает самостоятельное развертывание с опциональной интеграцией Sentry и Prometheus

Сценарии использования

• Добавление бейджей сборки, покрытия тестами и версии в README на GitHub
• Отображение числа загрузок пакета или версии релиза на главной странице проекта
• Программная генерация бейджей с помощью badge-maker в скрипте сборки Node.js
• Развертывание закрытого сервера бейджей для внутренней организации

Быстрый старт

1. 1

   Установите Node 24 с помощью предпочитаемого менеджера пакетов

2. 2

   Клонируйте этот репозиторий

3. 3

   Установите зависимости

   npm ci
4. 4

   Запустите сервер значков и сервер разработки фронтенда, затем откройте http://localhost:3000/

   npm start

Что важно знать

• !Для настройки среды разработки необходимы Node 24 и полное клонирование репозитория.

Темы

Частые вопросы

Что такое shields?

Shields.io — сервис и NPM-библиотека для создания компактных SVG- и растровых статусных бейджей для README-файлов и веб-страниц. Shields.io создает единообразные и хорошо читаемые бейджи со статусами, версиями, числом загрузок, покрытием тестами и другими показателями. Чтобы создать бейдж, достаточно указать URL, связанный с источником данных — например, CI-сервисом, реестром пакетов, магазином приложений или инструментом анализа кода. Изображение можно встроить в README на GitHub или любую другую веб-страницу. Сервис поддерживает десятки CI-сервисов, реестров пакетов, дистрибутивов, социальных сетей и инструментов контроля качества кода.

shields можно использовать бесплатно? Какая у него лицензия?

shields распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.

shields всё ещё поддерживается?

Активно поддерживается. Последний коммит в shields — 7 нояб. 2026 г..

Для чего можно использовать shields?

Добавление бейджей сборки, покрытия тестами и версии в README на GitHub Отображение числа загрузок пакета или версии релиза на главной странице проекта Программная генерация бейджей с помощью badge-maker в скрипте сборки Node.js Развертывание закрытого сервера бейджей для внутренней организации

Как установить shields?

Установите Node 24 с помощью предпочитаемого менеджера пакетов Клонируйте этот репозиторий Установите зависимости: npm ci Запустите сервер значков и сервер разработки фронтенда, затем откройте http://localhost:3000/: npm start

Где скачать shields?

Исходный код и инструкции по установке — на GitHub: https://github.com/badges/shields