jsdoc-readme
Automatically generate README.md documentation with jsdoc-style comments.
How To Use
$ npm install -g jsdoc-readme
$ cd /path/to/your/node/project
$ jsdoc-readme
Voila! The content of your node project's main library's jsdoc-style constructor description block is copied into the current directory's README.md file.
How It Works
- Checks package.json for the main library path.
- Get contents of the main constructor's jsdoc description block.
- Put contents into current directory's README.md.