mqtt-适配器
README 文件的标准化样式
您的 README 文件通常是您代码的第一个入口点。它应该告诉人们为什么他们应该使用您的模块，如何安装它，以及如何使用它。统一您编写 README 的方式使得创建和维护 READMEs 更容易。出色的文档需要工作！
此存储库包含
- README 标准化的规范。
- 一个链接，您可以使用它来维护您的 README (工作进行中)。
- 一个链接，您可以使用它来创建标准 READMEs (生成器)。
- 徽标 指向此规范。
- 标准 READMEs 的示例 - 例如您正在阅读的此文件。
Standard Readme 是为开源库设计的。虽然它在历史上是为 Node 和 npm 项目设计的，但它也适用于其他语言和包管理器中的库。
目录
背景
标准自述文件始于由 @maxogden 在 feross/standard 上的 此问题 提出的原始问题，关于一个规范化自述文件的工具是否有用。很多讨论最终都在 zcei 的 standard-readme 仓库中展开。在维护 IPFS 仓库的同时，我需要一个方法来在该组织内部规范化 Readme 文件。本规范由此诞生。
当有人可以使用你的模块而无需查看其代码时，你的文档就完整了。这非常重要。这使得你能够将模块的文档接口与其内部实现（内容）分开。这是好事，因为它意味着只要接口保持不变，你可以自由地更改模块的内部结构。
记住：定义模块功能的是文档，而不是代码。
撰写 README 文件非常困难，而且维护它们也很困难。通过卸载此过程——使写作更容易、编辑更容易、清楚是否达到了规范要求——你可以花更多的时间编写和使用代码，而不是担心最初的文档是否质量好。
通过有一个规范，用户可以花更少的时间搜索他们想要的信息。他们还可以构建工具以从描述中收集搜索词、自动运行示例代码、检查许可协议等。
本仓库的目标
- 一个定义良好的 规范。这可以在 规范文档 中找到。这是一项持续的工程；请提出问题以讨论变更。
- 一个示例 README。这个 Readme 完全符合 standard-readme 规范，更多示例在
example-readmes文件夹中。 - 一个用于检查给定 Readme 中错误的 检查器。请参阅 跟踪问题。
- 一个用于快速搭建新 README 的 生成器。请参阅 generator-standard-readme。
- 为用户提供的 合规徽标。请参阅 徽标。
安装
本项目使用 node 和 npm。如果你还没有本地安装它们，请查看它们。
$ npm install --global standard-readme-spec使用
这是一个仅包含文档的包。您可以打印 spec.md 到您的控制台中。
$ standard-readme-spec
# Prints out the standard-readme spec生成器
要使用生成器，请查看 generator-standard-readme。该包提供了一个全局可执行文件，别名为 standard-readme 来运行生成器。
徽章
如果你的 README 符合 Standard-Readme 且你在 GitHub 上，添加徽章将会很棒。这允许人们链接回此规范，并有助于 README 的采用。徽章是 非必须的。
在 Markdown 格式中添加，请使用此代码
[](https://github.com/RichardLitt/standard-readme)
示例 README 文件
要查看规范是如何应用的，请查看 示例 README 文件。
相关努力
- README 艺术品 -
💌 学习编写高质量 README 的艺术。 - open-source-template - 鼓励开源贡献的 README 模板。
维护者
贡献
随意参与！提出一个问题 或提交 PR。
Standard Readme 遵循 Contributor Covenant 行为准则。
贡献者
本项目的存在归功于所有做出贡献的人。请访问
许可协议
MIT © Richard Littauer