README.mdにnpmのバッジをつける

  • 7
    いいね
  • 0
    コメント
この記事は最終更新日から1年以上が経過しています。

NPM

NPM

よく見るこういうやつです。GitHubからそのモジュールがどのくらいダウンロードされてるか(人気か、使われてるか)分かっていいです。

https://nodei.coにアクセスすると参考画像とそのリンクが見られます。
Shut up and make me one NOW! ってとこは入力しても Package not found と表示されて使えないっぽいです。

npm install <package> のバッジ

https://nodei.coのBadge Stylesってとこを参照してください。

基本的に

[![NPM](https://nodei.co/npm/<package>.png)](https://nodei.co/npm/<package>/)

ってのをREADME.mdに追記すればよくって、上のページにあるような他の画像を使いたいならURLに引数で渡す感じです。

compact=true : 少し小さくなる。

[![NPM](https://nodei.co/npm/learnyoureact.png?compact=true)](https://nodei.co/npm/learnyoureact/)

NPM

mini=true : めっちゃ小さくなる。1行になる。

[![NPM](https://nodei.co/npm/learnyoureact.png?mini=true)](https://nodei.co/npm/learnyoureact/)

NPM

downloads=true : 先月のダウンロード数が下に出る。

[![NPM](https://nodei.co/npm/learnyoureact.png?downloads=true)](https://nodei.co/npm/learnyoureact/)

NPM

downloadRank=true : ダウンロード数のランキングが下に出る。

[![NPM](https://nodei.co/npm/learnyoureact.png?downloadRank=true)](https://nodei.co/npm/learnyoureact/)

NPM

stars=true : 何も出てない気がする。よく分からない。

[![NPM](https://nodei.co/npm/learnyoureact.png?stars=true)](https://nodei.co/npm/learnyoureact/)

NPM

downloads=true&downloadRank=true&stars=true : ダウンロード数、ランキングが出る。stars は効いてない気がする。

[![NPM](https://nodei.co/npm/learnyoureact.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/learnyoureact/)

NPM

②ヒストグラムのバッジ

https://nodei.coのDownload histogram badgesってとこを参照してください。
こっちも基本的に

[![NPM](https://nodei.co/npm-dl/<package>.png)](https://nodei.co/npm/<package>/)

をREADME.mdに追記すれば良くて、他のを使いたかったらURLに引数で渡す感じです。

months=x : ヒストグラムの横軸の月数を1〜12の数値で指定。

(3ヶ月の例)

[![NPM](https://nodei.co/npm-dl/learnyoureact.png?months=3)](https://nodei.co/npm/learnyoureact/)

NPM

height=y : ヒストグラムの縦の高さを1〜3の数値で指定。

(高さ2の例)

[![NPM](https://nodei.co/npm-dl/learnyoureact.png?height=2)](https://nodei.co/npm/learnyoureact/)

NPM