Generate a README.md from package.json contents. [Fork https://github.com/zeke/package-json-to-readme/]
MIT License
Generate a README.md from package.json contents.
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
# 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
dsa
To run the test suite, first install the dependencies, then run test
:
# Using Yarn
yarn test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. List of all contributors.