search

ZijianHe / koa-router

Router middleware for koa.
MIT License
4.85k stars 407 forks source link

Modify README.md #442

Closed brazenest-zz closed 6 years ago

brazenest-zz commented 6 years ago

Hoping this helps :smiley:

jbielick commented 6 years ago

Hi @brazenest !

Thanks for your submission. I see that you've modified the readme in your PR and I think that might present some problems because the readme is programmatically generated by jsdoc.

The readme template is in the repo (lib/README_tpl.hbs). Almost all of the readme is generated from comments in the source code (this is how jsdoc works), so to change the content you should change the comments in the source. Otherwise your changes will get overwritten the next time we generate the docs. Does that make sense? See the package.json for a task named "docs" and the command to generate them is there.