npm 包 readme-badges 使用教程

当您创建自己的 npm 包并将其发布到 npmjs.com 上时，您肯定希望让其他人知道它存在并了解它。为此，您需要提供一份良好的文档说明，其中包括有关您的项目的信息和用法示例。在这里，我们将介绍如何使用 readme-badges 来改善文档的可读性。

什么是 readme-badges？

readme-badges 是一个 npm 包，可以帮助您在 README.md 文件中添加各种徽章（badges），以便更好地展示项目的状态和统计信息。这些徽章是 SVG 图片，可以轻松地集成到社交媒体、博客或任何其他网站上。下面是一些常见的徽章示例：

• npm：显示该 npm 包的当前版本号和下载次数；
• GitHub：显示该项目的 star 数量、最新版本号和构建状态等；
• Travis CI：显示 Travis CI 的构建状态；
• Coveralls：显示代码覆盖率。

如何使用 readme-badges？

要使用 readme-badges，您需要首先安装它。在命令行中运行以下命令即可：

npm install readme-badges --save-dev

然后，在您的项目的 README.md 文件中添加如下内容：

# My Project

[![npm version](https://img.shields.io/npm/v/my-project.svg)](https://www.npmjs.com/package/my-project)
[![npm downloads](https://img.shields.io/npm/dt/my-project.svg)](https://www.npmjs.com/package/my-project)

这将在您的 README 文件中添加两个徽章：npm version 和 npm downloads。其中，npm version 徽章会显示当前 npm 包的版本号，而 npm downloads 徽章则显示下载次数。

您可以根据需要自定义这些徽章，例如修改链接和徽章颜色等。更多信息请参见 readme-badges 文档。

为什么使用 readme-badges？

添加徽章可以让您的项目文档更好的展示您的项目的状态和统计信息。这样做有以下几个好处：

• 提高可读性：徽章的存在可以让文档更加清晰易懂，同时也能够吸引用户的眼球。
• 增强信任感：徽章可以增加项目的权威感和可信度，在一定程度上增强用户对项目的信任感。
• 促进社区互动：通过添加徽章，您可以方便地展示项目的最新动态，吸引更多的开发者参与到您的项目中来。

示例代码

以下是一个完整的示例代码，展示如何使用 readme-badges 添加徽章：

# My Project

[![npm version](https://img.shields.io/npm/v/my-project.svg)](https://www.npmjs.com/package/my-project)
[![npm downloads](https://img.shields.io/npm/dt/my-project.svg)](https://www.npmjs.com/package/my-project)
[![Build Status](https://travis-ci.org/my-account/my-project.svg?branch=master)](https://travis-ci.org/my-account/my-project)
[![Coverage Status](https://coveralls.io/repos/github/my-account/my-project/badge.svg?branch=master)](https://coveralls.io/github/my-account/my-project?branch=master)

这个例子添加了四个徽章：npm version、npm downloads、Build Status 和 Coverage Status。其中，Build Status 和 Coverage Status 徽章显示的是 Travis CI 和 Coveralls 的构建和覆盖率统计信息。

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