很多人懒得写readme，虽然markdown写起来已经够简单了，但是还是写不出好看的readme，因为觉得写文档是一件很麻烦的事情，我经常在npm上开坑，发现readme很多东西都可以从package.json中抓出来然后排版好，docor这个工具就做了这样一个工作。
$ sudo npm install docor -g
然后在你的目录下npm init之后，会有一个package.json文件，这个时候在本目录执行 docor 就可以看到生成的readme，根据pkg指定的license文件，和相应的ignore文件了。
我还写了一些小功能，比如从pkg.main文件里将暴露出来的函数打印在readme中，方便以后写api文档。如果要指定文档的logo，可以在package.json中加一个 { "logo": "someurl" }
目前有两个readme模板，如果希望要自己修改这个默认模板，可以在你的全局模块目录里修改 tpl/readme.md
如果要新建中文语言的readme，可以这样: $ docor -c README.zh-cn.md，中文模板文件也在tpl目录下。
Github:
https://github.com/turingou/docor
$ sudo npm install docor -g
然后在你的目录下npm init之后，会有一个package.json文件，这个时候在本目录执行 docor 就可以看到生成的readme，根据pkg指定的license文件，和相应的ignore文件了。
我还写了一些小功能，比如从pkg.main文件里将暴露出来的函数打印在readme中，方便以后写api文档。如果要指定文档的logo，可以在package.json中加一个 { "logo": "someurl" }
目前有两个readme模板，如果希望要自己修改这个默认模板，可以在你的全局模块目录里修改 tpl/readme.md
如果要新建中文语言的readme，可以这样: $ docor -c README.zh-cn.md，中文模板文件也在tpl目录下。
Github:
https://github.com/turingou/docor
Select Language