pkg-readme

pkg-readme

Generate a Standard Readme Style compliant README from your package.json

Table of Contents

• Install
• Usage
• Contribute
• License

Install

This project uses node and npm.

$ npm install pkg-readme
$ # OR
$ yarn add pkg-readme

Usage

const generateReadme = require('./')

const args = {
  name: '', // Name of package
  description: '', // Description of package
  license: '', // Package license
  example: '' // name of example file in current directory that will be put into the usage section as code block
}

generateReadme(args)
  .then(console.log)
  .catch(console.error)

Using the CLI (Same options):

$ pkg-readme --license=FOOBAR

Contribute

• Fork it and create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request

License

MIT