模块名称 徽章 可选徽章,例如npm版本,测试和构建范围等。 概括 一句或两句描述模块的功能。 概述 (可选)包括一个或两个段落的一部分,其中包含有关模块的功能,解决的问题,使用原因以及使用方式的更多高级信息。 不要只重复摘要中的内容。 安装 $ npm install module-name 基本用途 有关如何使用该模块的一般说明和基本示例。 API 完整的API文档。 例子 此处的其他示例。 测验 包括哪些测试以及如何运行它们。 贡献 该项目欢迎社区的贡献。 使用GitHub pull请求接受贡献; 有关更多信息,请参阅。 对于良好的拉取请求,我们要求您提供以下信息: 在说明中包括您的拉取请求的清晰说明,并带有基本的“ what”和“ why”。 测试应尽可能地通过。 GitHub也将自动运行测试,以充当安全网。 拉取请求应包括对变更的测试。 一个新功能应该对该新功能进行测