https://github.com/pablopunk/readmer
Module to create simple markdown readme for a project
https://github.com/pablopunk/readmer
Last synced: 8 months ago
JSON representation
Module to create simple markdown readme for a project
- Host: GitHub
- URL: https://github.com/pablopunk/readmer
- Owner: pablopunk
- License: mit
- Created: 2017-06-01T02:09:19.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-02T21:10:51.000Z (over 8 years ago)
- Last Synced: 2024-05-02T05:12:19.012Z (about 2 years ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/readmer
- Size: 48.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# readmer
Module to create simple markdown readme for a project
## Install
```bash
npm install --save readmer
```
## Usage
```javascript
const readmer = require('readmer')
readmer().then(console.log)
/* =>
# readmer
Module to create simple markdown readme for a project
## Install
npm install readmer
...
*/
```
## Options
```javascript
readmer(
'package.json', // path to package.json
{ // optional
gravatarEmail: 'Email to retrieve gravatar image'
}
)
```
## Contribute
Feel free to open an _issue_ or a _PR_.
## Related
CLI for this module => [readmer-cli](https://github.com/pablopunk/readmer-cli)
Minimal node boilerplate => [miny](https://github.com/pablopunk/miny)
## Author
| |
| -----------------------------------------------------------------------------|
| © 2017 [__Pablo Varela__](http://pablo.life) |