在前端开发中，经常会利用 npm 包来完成开发工作。而每个 npm 包都应该有一个详细的文档来说明如何使用它。而 readme-filename 就是一个方便的 npm 包，可以为你的项目添加一个易于找到的 README 文件。在这篇文章中，我们将介绍如何使用 readme-filename 包来快速创建 README 文件。
安装
在使用 readme-filename 包之前，需要先安装它。可以使用以下命令安装：
npm install --save-dev readme-filename
创建 README 文件
安装完成后，可以通过以下命令来创建 README 文件：
npx readme-filename
执行该命令后，它将自动创建 README 文件并将其添加到项目根目录。默认情况下，它会将 README 文件命名为 README.md。如果你想使用其他名称，你可以提供一个参数，例如：
npx readme-filename README-chinese.md
以上命令将创建 README-chinese.md 文件。
添加内容
创建 README 文件之后，需要根据你的项目添加内容。以下是一些常见的内容：
介绍
添加一个简要介绍你的项目是非常有必要的。在介绍中，你可以说明项目是做什么的，它的功能以及你的项目可以解决什么问题。
安装
在这一段中，你可以说明如何安装项目。例如，如果你的项目是一个库，用户可以通过 npm 安装它。如果你的项目需要其他依赖，你可以在这一段中提到它们。
使用
在这一段中，你可以提供使用项目的详细说明。它应该按照自然的顺序，从简单到复杂地描述如何使用项目。包括 API 的使用和示例代码。
贡献
在这一段中，你可以说明如何贡献到项目中。这通常包括在 GitHub 上提交 issue 和 pull request。你可以在这一段中指定如何提交代码，并提供规则和指南。
总结
通过 readme-filename 包创建 README 文件可以帮助你更好的组织你的项目文档，让它更易于理解和使用。通过以上方式的创建快速学习，相信你会很快上手。享受创作的乐趣吧！
示例代码：
# 项目名称 在这里添加项目简介 ## 安装 在此处添加安装说明，例如使用 npm 安装：
npm install my-project --save
## 使用 在此处添加使用说明：
import myProject from 'my-project';
myProject.someMethod();
-- -------------------- ---- ------- --------- --- --- -- -- ---------- -- ---- --- -- ---- -- ------ -- ---- ---- ------- ------------------ -- ---- - ---------- -------- ------- ---
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66090