readme-me
v1.0.0
Published
Generate README from package.json and example files
Downloads
2
Readme
readme-me
Create README from package.json and example files
Usage
Run readme-me
from the module directory you want to generate a new README.md
for
$ cd path/to/new-module
$ readme-me
package.json
is required.
readme-me
looks for the following attributes/files:
pkg.name
pkg.description
pkg.license
.travis.yml
andpkg.repository.url
example.js
License
MIT