https://github.com/pablopunk/readmer-cli
Create simple Readme files automatically
https://github.com/pablopunk/readmer-cli
Last synced: about 1 year ago
JSON representation
Create simple Readme files automatically
- Host: GitHub
- URL: https://github.com/pablopunk/readmer-cli
- Owner: pablopunk
- Created: 2017-06-01T02:14:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-02T21:11:47.000Z (over 8 years ago)
- Last Synced: 2024-05-02T05:12:19.159Z (about 2 years ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# readmer-cli
Create simple Readme files automatically
## Install
```bash
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 me@example.com > 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](https://github.com/pablopunk/readme).
## Related
API for this module => [readmer](https://github.com/pablopunk/readmer)
Minimal node boilerplate => [miny](https://github.com/pablopunk/miny)
## Author
| |
| -----------------------------------------------------------------------------|
| © 2017 [__Pablo Varela__](http://pablo.life) |