回顧前三章內(nèi)容，討論了koa的核心模塊 koa-compose的實(shí)現(xiàn)，自己實(shí)現(xiàn)一個(gè)簡(jiǎn)單的koa，以及koa實(shí)現(xiàn) status code反向映射的操作。那對(duì)于一個(gè)開(kāi)源項(xiàng)目還缺少什么呢？至少還缺少以下幾個(gè)方面：
- 完整的測(cè)試用例
- 標(biāo)準(zhǔn)的API文檔
- 代碼執(zhí)行效率分析
- README
從README開(kāi)始
如果你想讓別人盡快的了解你的項(xiàng)目，就需要想盡辦法在README上下些功夫。
一個(gè)好的 README需要告訴其他可能的協(xié)作者：
- 項(xiàng)目的作用及解決的問(wèn)題
- 如何開(kāi)始項(xiàng)目
- 如何編譯、安裝、運(yùn)行
- 貢獻(xiàn)者
- 許可
標(biāo)準(zhǔn)示例
readme示例
當(dāng)然，使用更加漂亮的圖標(biāo)和banner，更加容易將項(xiàng)目進(jìn)行推廣。
koa的README
在第一版本中，koa的readme是這樣的：
