❤
npm
Sign UpSign In

jsdoc-readme

0.0.2 • Public • Published

jsdoc-readme

Automatically generate README.md documentation with jsdoc-style comments.

How To Use

  1. $ npm install -g jsdoc-readme
  2. $ cd /path/to/your/node/project
  3. $ 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

  1. Checks package.json for the main library path.
  2. Get contents of the main constructor's jsdoc description block.
  3. Put contents into current directory's README.md.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.0.2
    1
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.0.2
    1

Package Sidebar

Install

npm i jsdoc-readme

Repository

github.com/FreeAllMedia/jsdoc-readme

Homepage

github.com/FreeAllMedia/jsdoc-readme#readme

Weekly Downloads

1

Version

0.0.2

License

GPLv3

Last publish

Collaborators

  • dsliek
Try on RunKit
Report malware