readme-me

1.0.0 • Public • Published

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

Readme

Keywords

none

Package Sidebar

Install

npm i readme-me

Weekly Downloads

0

Version

1.0.0

License

MIT

Last publish

Collaborators

  • timhudson