About
Generate a README.md from package.json contents. [Fork https://github.com/zeke/package-json-to-readme/] by Tiago Danin.
Generate a README.md from package.json contents.
- Automate and improve your readme
- Awesome badges (Travis CI, XO, NPM Download...)
- List dependencies
- Load documentation
- Sort dependencies, badges and others keys
- Screenshot
Module available through the npm registry. It can be installed using the npm
or yarn
command line tool.
yarn global add gen-readme
npm install gen-readme --global
gen-readme --help
gen-readme package.json
gen-readme package.json > README.md
gen-readme package.json --travis
gen-readme package.json --write
gen-readme package.json --no-badges
To run the test suite, first install the dependencies, then run test
:
yarn test
debug: small debugging utility
Author: TJ Holowaychuk
License: MIT
Version: ^4.1.1
github-url-to-object: Extract user, repo, and other interesting properties from GitHub URLs
Author: zeke
License: MIT
Version: ^4.0.4
handlebars: Handlebars provides the power necessary to let you build semantic templates effectively with no frustration
Author: Yehuda Katz
License: MIT
Version: ^4.7.6
locate-path: Get the first path that exists on disk of multiple paths
Author: Sindre Sorhus
License: MIT
Version: ^5.0.0
lodash: Lodash modular utilities.
Author: John-David Dalton
License: MIT
Version: ^4.17.15
meow: CLI app helper
Author: Sindre Sorhus
License: MIT
Version: ^7.0.1
package-info: Get the information of a npm package
Author: Alessandro Minoccheri
License: MIT
Version: ^3.0.2
update-notifier: Update notifications for your CLI app
Author: Sindre Sorhus
License: BSD-2-Clause
Version: ^4.1.0
xo: JavaScript/TypeScript linter with great defaults
Author: Sindre Sorhus
License: MIT
Version: ^0.30.0
package-json-to-readme: Generate a README.md from package.json contents
Author: Zeke Sikelianos
License: MIT
gen-package: Intuitive and user-friendly generator of package.json
Author: TiagoDanin
License: MIT
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. List of all contributors.
MIT © Tiago Danin