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 --globalUsage
# 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-badgesExample
dsaTests
To run the test suite, first install the dependencies, then run test:
# Using Yarn
yarn testDependencies
github-url-to-object: Extract user, repo, and other interesting properties from GitHub URLs
Author: zekeLicense: MIT
Version: ^4.0.4
handlebars: Handlebars provides the power necessary to let you build semantic templates effectively with no frustration
Author: Yehuda KatzLicense: MIT
Version: ^4.7.6
locate-path: Get the first path that exists on disk of multiple paths
Author: Sindre SorhusLicense: MIT
Version: ^5.0.0
package-info: Get the information of a npm package
Author: Alessandro MinoccheriLicense: MIT
Version: ^3.0.2
upath: A proxy to `path`, replacing `\` with `/` for all results & new methods to normalize & join keeping leading `./` and add, change, default, trim file extensions.
Author: Angelos PikoulasLicense: MIT
Version: ^1.2.0
update-notifier: Update notifications for your CLI app
Author: Sindre SorhusLicense: BSD-2-Clause
Version: ^4.1.0
Dev Dependency
xo: JavaScript/TypeScript linter with great defaults
Author: Sindre SorhusLicense: MIT
Version: ^0.30.0
Related
package-json-to-readme: Generate a README.md from package.json contents
Author: Zeke SikelianosLicense: MIT
gen-package: Intuitive and user-friendly generator of package.json
Author: TiagoDaninLicense: MIT
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
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)
