1.3.0 • Published 7 years ago
readmer v1.3.0
readmer
Install
npm install --save readmer
Usage
const readmer = require('readmer')
readmer().then(console.log)
/* =>
# readmer
<p align="center">
<i>Module to create simple markdown readme for a project</i>
</p>
## Install
npm install readmer
...
*/
Options
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
Author
© 2017 Pablo Varela |