文件顶部应有一个简短的简介和/或概述，解释项目是关于什么的。此说明应与为包管理器添加的说明（Gemspec、package.json 等）相匹配
尽可能简洁地展示库的作用，开发者应能够通过查看代码示例来理解项目是如何解决问题的。确保展示的 API 明显，并且代码短小精悍。
简要描述创建和维护此项目的动机。这应解释为什么此项目存在。
提供代码示例和说明如何获取项目的方法。
根据项目的大小，如果项目小而简单，可以将参考文档添加到 README 中。对于中等或较大的项目，至少提供指向 API 参考文档的链接。
描述和展示如何通过代码示例运行测试。
告诉人们他们如何参与项目，包括问题追踪器、IRC、Twitter 账户等重要链接。
简要描述许可协议（MIT、Apache 等）