❤
npm
Sign UpSign In

pretty-readme

2.3.0 • Public • Published

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

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 2.3.0
    4
    • latest

Version History

Package Sidebar

Install

npm i pretty-readme

Repository

github.com/chunpu/pretty-readme

Homepage

github.com/chunpu/pretty-readme

Weekly Downloads

4

Version

2.3.0

License

ISC

Unpacked Size

10.3 kB

Total Files

8

Last publish

Collaborators

  • ftft1885
Try on RunKit
Report malware