このツールに問題がありますか?

「Readme Badges Generator Online」について

このツールは、GitHub README(または任意の Markdown ドキュメント)用のバッジスニペットを生成します。バッジはビルド状態、カバレッジ、パッケージバージョン、ライセンス、DL 数、SNS 存在感などを視覚的に示し、プロジェクトの完成度と信頼感を一気に高めます。

shields.io スタイルのバッジ(npm バージョン、DL)、CI(GitHub Actions、CircleCI)、コード品質(Codecov、Coveralls)、ライセンス(MIT、Apache-2.0)、メタ情報(最終コミット、コントリビューター)など。

出力は README の冒頭に貼り付けられる Markdown。多くのバッジは外部サービスにリンクし自動更新されるため、追加後はファイルを編集せずに常時最新表示になります。

このツールの使い方

npm パッケージ用の README バッジを生成する手順

  1. パッケージ名を入力

    「Package name」は npm に公開された正確な名前。`@scope/name` のスコープ付きも、スコープ無し `name` と同じ扱い。空白は自動でトリム。

  2. 「実行」

    結果は `markdown` のみで、shields.io の画像リンクが 3 つ:最新公開バージョン、週間ダウンロード数、SPDX ライセンス。改行なしで横並びにレンダリングされます。

  3. データの出所

    各バッジは shields.io の URL で、表示時に npm レジストリのエンドポイントへアクセスします。自動更新されるので、新バージョン公開時に再生成は不要です。

  4. バッジのカスタマイズ

    そのまま README の冒頭に貼り付けてください。スタイルを変えたければ生成 URL を編集 — shields.io は `?color=blue`、`?style=flat-square`、`?logo=npm` 等のパラメータをサポートします。全パラメータは shields.io の公式リファレンスで。