readmer-cli

Create simple Readme files automatically

Install

npm install -g readmer-cli

Usage

Use readmer -h to display this help:

  Usage: readmer [options] [command]

  Commands:
    help  Display help

  Options:
    -g, --gravatar  A gravatar email to retrieve a profile picture
    -h, --help      Output usage information
    -v, --version   Output the version number

  Examples:
    - Show simple readme file
    $ readmer

    - Create README.md
    $ readmer > README.md

    - Create README.md fo the parent directory
    $ readmer ../package.json > ../README.md

    - Create readme.md with the author's gravatar
    $ readmer -g [e-mail] > readme.md

Contribute

Feel free to open an issue or a PR.

NOTE: For issues regarding the markdown output, data options, etc, refer to the API repo.

Related

API for this module => readmer

Author

© 2017 Pablo Varela