README.md

node-module-boilerplate

Boilerplate to kickstart creating a Node.js module

This is what I use for my own modules.

Getting started

Click the "Use this template" button.

Alternatively, create a new directory and then run:

$ curl -fsSL https://github.com/ksathyanm/node-module-boilerplate/archive/master.tar.gz | tar -xz --strip-components=1

---

Remove everything from here and above

---

node-module-boilerplate

My awesome module

Install

$ npm install node-module-boilerplate

Usage

const unicornFun = require("node-module-boilerplate")

unicornFun("unicorns")
//=> "unicorns & rainbows"

API

unicornFun(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string
Default: rainbows

Lorem ipsum.