Gen README

Generate a README.md from package.json contents.

Features

• Automate and improve your readme
• Awesome badges (Travis CI, XO, NPM Download...)
• List dependencies
• Load documentation
• Sort dependencies, badges and others keys
• Screenshot

Installation

Module available through the npm registry. It can be installed using the npm or yarn command line tool.

# Yarn (Recomend)
yarn global add gen-readme
# NPM 
npm install gen-readme --global

Usage

# Show help
gen-readme --help

# Write to stdout
gen-readme package.json

# Pipe output into a new file
gen-readme package.json > README.md

# Add a Travis badge (if not exit .travis.yml)
gen-readme package.json --travis

# Output in README.md
gen-readme package.json --write

# Disable default badges
gen-readme package.json --no-badges

Example

dsa

Tests

To run the test suite, first install the dependencies, then run test:

# Using Yarn
yarn test

Dependencies

Dev Dependency

Related

Contributors

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. List of all contributors.

Thanks

• zeke: Gen README is an fork of https://github.com/zeke/package-json-to-readme/

License

MIT © Tiago Danin