С этим инструментом что-то не так?

О «Readme Badges Generator Online»

Этот инструмент собирает Markdown-бэйджи для GitHub README (или любого Markdown). Бэйджи показывают статус сборки, покрытие, версию пакета, лицензию, загрузки, соцприсутствие — проект выглядит профессионально и надёжно.

Популярные типы: бэйджи стиля shields.io (npm-версия, скачивания), CI (GitHub Actions, CircleCI), качество кода (Codecov, Coveralls), лицензия (MIT, Apache-2.0), метаданные (последний коммит, контрибьюторы).

Готовые сниппеты в Markdown, вставляются вверху README. Большинство бэйджей привязаны к внешним сервисам и обновляются автоматически — править файл не нужно.

Как пользоваться этим инструментом

Как сгенерировать README-бейджи для npm-пакета

  1. Имя пакета

    "Package name" ждёт точное имя пакета npm в том виде, как опубликовано — scoped (`@scope/name`) работает так же, как unscoped `name`. Пробелы автоматически срезаются.

  2. Запуск

    Результат — единственное поле `markdown` с тремя картинками shields.io: последняя опубликованная версия, недельные скачивания и SPDX-лицензия. Рендерятся подряд без переводов строки.

  3. Откуда данные

    Каждый бейдж — URL на shields.io, который во время рендера дёргает endpoint'ы npm registry. Обновляются автоматически — после публикации новой версии перегенерировать не нужно.

  4. Кастомизация

    Вставьте markdown в начало README. Хотите другой стиль? Правьте сгенерированные URL — shields.io поддерживает `?color=blue`, `?style=flat-square`, `?logo=npm` и много чего ещё. Полный справочник параметров — на shields.io.

Похожие инструменты