Nameless Package Manager

    readme-example

    0.0.3 • Public • Published

    readme example

    Pipe a code example into a readme template

    install

    $ npm install -g readme-example
    

    example

    Templates are underscore style.

    _readmeTmpl.md:

    # my module
    
    ## example
    
    ```js
    <%= example %>
    ```
    

    On the command line:

    $ cat example/code.js | readme-example _readmeTmpl.md > readme.md
    

    Results in readme.md:

    # my module
    
    ## example
    
    ```js
    console.log('example');
    
    ```
    

    Install

    npm i readme-example

    DownloadsWeekly Downloads

    0

    Version

    0.0.3

    License

    ISC

    Last publish

    Collaborators

    • nichoth