Nifty Procrastination Machine

    readmer

    1.3.0 • Public • Published

    readmer

    Module to create simple markdown readme for a project

    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

    me
    © 2017 Pablo Varela

    Install

    npm i readmer

    DownloadsWeekly Downloads

    1

    Version

    1.3.0

    License

    MIT

    Last publish

    Collaborators

    • pablopunk