gen-readme
Generate a README.md from package.json contents.
Last updated 5 months ago by tiagodanin .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gen-readme -g
SYNC missed versions from official npm registry.

Gen README

Travis Downloads Node Version Fork XO code style

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

<summary> debug: small debugging utility</summary> Author: TJ Holowaychuk
License: MIT
Version: ^4.1.1
<summary> github-url-to-object: Extract user, repo, and other interesting properties from GitHub URLs</summary> Author: zeke
License: MIT
Version: ^4.0.4
<summary> handlebars: Handlebars provides the power necessary to let you build semantic templates effectively with no frustration</summary> Author: Yehuda Katz
License: MIT
Version: ^4.7.6
<summary> locate-path: Get the first path that exists on disk of multiple paths</summary> Author: Sindre Sorhus
License: MIT
Version: ^5.0.0
<summary> lodash: Lodash modular utilities.</summary> Author: John-David Dalton
License: MIT
Version: ^4.17.15
<summary> meow: CLI app helper</summary> Author: Sindre Sorhus
License: MIT
Version: ^7.0.1
<summary> package-info: Get the information of a npm package</summary> Author: Alessandro Minoccheri
License: MIT
Version: ^3.0.2
<summary> upath: A proxy to `path`, replacing `\` with `/` for all results & new methods to normalize & join keeping leading `./` and add, change, default, trim file extensions.</summary> Author: Angelos Pikoulas
License: MIT
Version: ^1.2.0
<summary> update-notifier: Update notifications for your CLI app</summary> Author: Sindre Sorhus
License: BSD-2-Clause
Version: ^4.1.0

Dev Dependency

<summary> xo: JavaScript/TypeScript linter with great defaults</summary> Author: Sindre Sorhus
License: MIT
Version: ^0.30.0

Related

<summary> package-json-to-readme: Generate a README.md from package.json contents</summary> Author: Zeke Sikelianos
License: MIT
<summary> gen-package: Intuitive and user-friendly generator of package.json</summary> Author: TiagoDanin
License: MIT

Contributors

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

Thanks

License

MIT © Tiago Danin

Current Tags

  • 1.6.0                                ...           latest (5 months ago)
  • 1.4.3-0                                ...           next (10 months ago)

16 Versions

  • 1.6.0                                ...           5 months ago
  • 1.5.1                                ...           5 months ago
  • 1.5.0                                ...           5 months ago
  • 1.4.3-0                                ...           10 months ago
  • 1.4.2                                ...           a year ago
  • 1.4.1                                ...           a year ago
  • 1.4.0                                ...           a year ago
  • 1.3.2                                ...           2 years ago
  • 1.3.1                                ...           2 years ago
  • 1.3.0                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.2                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (9)
Dev Dependencies (1)
  • xo ^0.30.0
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |