npm 包 badge-up 使用教程

很多前端项目都使用 npm 包作为依赖，而 badge-up 是一个非常实用的工具，可以让你很方便地在 README.md 文件上添加各种徽章。接下来我们将详细介绍如何使用这个工具。

安装 badge-up

1. 在命令行中输入以下命令进行安装：

npm install -g badge-up

1. 安装完成后，在命令行中输入以下命令查看是否安装成功：

badge-up --version

如果出现版本号说明安装成功。

添加徽章

1. 在要添加徽章的 npm 项目的根目录下新建一个 badges.json 文件

touch badges.json

1. 打开 badges.json 文件，输入以下代码：

-- -------------------- ---- -------
-
  --------- -
    -
      -------- ---- ---------
      -------- ------------------------------------------------------
    --
    -
      -------- ----------
      -------- -----------------------------------------------------------------------------------
    -
  -
-

1. 修改代码中的 <your-package-name> 和 <your-github-username>/<your-repo-name> 为你自己的 npm 包名和 Github 信息。

2. 在 README.md 文件中添加以下代码：

[![npm package](https://img.shields.io/npm/v/<your-package-name>.svg)](https://www.npmjs.com/package/<your-package-name>)
[![License](https://img.shields.io/github/license/<your-github-username>/<your-repo-name>.svg)](https://github.com/<your-github-username>/<your-repo-name>/blob/master/LICENSE)

1. 将上面代码中的 <your-package-name> 和 <your-github-username>/<your-repo-name> 替换为你自己的 npm 包名和 Github 信息。

2. 在命令行中进入项目根目录，运行以下命令：

badge-up

这个命令将会更新 README.md 文件，添加上你指定的徽章。

结论

通过本教程，你已经学会了如何使用 badge-up 工具添加徽章。现在你可以在你的 README.md 文件中展示你的项目的状态、版本、许可证等信息了。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/46375