node package manager

pretty-readme

pretty-readme

Build status NPM version Downloads Dependency Status

Test coverage Gittip Gitter

Generate pretty readme for your repo using package.json

Installation

npm i pretty-readme -g

Usage

  1. Write your custom readme in .README.md
  2. Execute pretty-readme
  3. Auto generate README.md with badges

Options

  Usage: pretty-readme [options]
 
 
  Options:
 
    -V, --version             output the version number
    -o, --output-file [file]  output file default README.md
    -i, --input-file [file]   input file default .README.md
    --coveralls               use coveralls badge
    --gittip                  use gittip badge
    --gitter                  use gitter badge
    -h, --help                output usage information

Other Badges

License

License