pretty-readme
Generate pretty readme for your repo using package.json
Last updated 2 days ago by ftft1885 .
ISC · Repository · Bugs · Original npm · Tarball
$ cnpm install pretty-readme 
SYNC missed versions from official npm registry.

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

'quote'
  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

Maintainers (1)
Downloads
Today 0
This Week 0
This Month 16
Last Day 0
Last Week 16
Last Month 14
Dependencies (6)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |