Have ideas to improve npm?Join in the discussion! »

    readme-md

    0.8.0 • Public • Published

    readme-md

    npm Version Node.js GitHub License Build Status

    A README.md generator library.

    Install

    $ yarn add readme-md # Or alternatively: `npm install --save readme-md` 

    Usage

    'use strict';
     
    const readme = require('readme-md');
     
    const pkg = {name: 'my-awesome-package'};
    const additionalSections = [
        {
            position: 'after:Install',
            title: 'Usage',
            body: "```js\nrequire('my-awesome-package')({awesome: 'parameters'});\n```"
        }
    ];
     
    readme({pkg, additionalSections});
    // > my-awesome-package
    // > ==================
    // > _To be documented._
    // >
    // > Install
    // > -------
    // > ```sh
    // > $ npm install --save my-awesome-package
    // > ```
    // >
    // > Usage
    // > -----
    // > ```js
    // > require('my-awesome-package')({awesome: 'parameters'});
    // > ```
    // >
    // > Testing
    // > -------
    // > _To be documented._
    // >
    // > License
    // > -------
    // > _To be documented._

    Testing

    $ yarn test # Or alternatively: `npm test` 

    See Also

    License

    The MIT License (Expat). See the license file for details.

    Install

    npm i readme-md

    DownloadsWeekly Downloads

    14

    Version

    0.8.0

    License

    MIT

    Last publish

    Collaborators

    • avatar