15. 编写友好的说明文档
我们的包就已经可以发布了吗？并没有，一个优秀的扩展包应该包含友好的说明文档，所以发布前我们先来完善说明文档，开源项目一般是在项目根目录创建 README.md 作为使用文档，当然，如果你的项目过于复杂，那么你可能需要将文档放到项目 docs 文件夹下，我们这里主要介绍普通复杂度的扩展包文档的编写。
一份友好的文档应该包含下面这些信息：
- 项目简介及创作动机
- 项目维护、CI、依赖更新状态（如果有）
- features & 适用人群
- 运行的平台或硬件要求
- 重要依赖
- 如何安装与测试
- 使用示例及文档地址
- 贡献指南
- License
- 鸣谢
- 其它特有的信息
比如我们的扩展包的 README 信息就可以像下面这样来编写：
Weather
基于 高德开放平台 的 PHP 天气信息组件。
安装
$ composer require overtrue/weather -vvv配置
在使用本扩展之...
关于 LearnKu
粤公网安备 44030502004330号