pkg-readme

1.1.0 • Public • Published

pkg-readme

package version package downloads standard-readme compliant package license make a pull request

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

Table of Contents

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

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

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i pkg-readme

Weekly Downloads

0

Version

1.1.0

License

MIT

Unpacked Size

7.05 kB

Total Files

9

Last publish

Collaborators

  • tiaanduplessis