readme-me
Generate README from package.json and example files
Last updated 5 years ago by timhudson .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install readme-me 
SYNC missed versions from official npm registry.

readme-me

Create README from package.json and example files

build status

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 and pkg.repository.url
  • example.js

License

MIT

Current Tags

  • 1.0.0                                ...           latest (5 years ago)

2 Versions

  • 1.0.0                                ...           5 years ago
  • 0.1.0                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (1)
Dev Dependencies (1)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |