《Koa诞生记》——如何写好README

回顾前三章内容,讨论了koa的核心模块 koa-compose的实现,自己实现一个简单的koa,以及koa实现 status code反向映射的操作。那对于一个开源项目还缺少什么呢?至少还缺少以下几个方面:

  • 完整的测试用例
  • 标准的API文档
  • 代码执行效率分析
  • README

从README开始

如果你想让别人尽快的了解你的项目,就需要想尽办法在README上下些功夫。

一个好的 README需要告诉其他可能的协作者:

  • 项目的作用及解决的问题
  • 如何开始项目
  • 如何编译、安装、运行
  • 贡献者
  • 许可

标准示例

readme示例

当然,使用更加漂亮的图标和banner,更加容易将项目进行推广。

koa的README

在第一版本中,koa的readme是这样的:

素材&应用

从零开始写README

你可能感兴趣的:(《Koa诞生记》——如何写好README)