Boilerplate to kickstart creating a Node.js module
This is what I use for my own modules.
Also check out node-cli-boilerplate
.
Click the "Use this template" button.
Alternatively, create a new directory and then run:
$ curl -fsSL https://github.com/sindresorhus/node-module-boilerplate/archive/master.tar.gz | tar -xz --strip-components=1
There's also a Yeoman generator.
Remove everything from here and above
My awesome module
$ npm install unicorn-fun
const unicornFun = require('unicorn-fun');
unicornFun('unicorns');
//=> 'unicorns & rainbows'
Type: string
Lorem ipsum.
Type: object
Type: string
Default: rainbows
Lorem ipsum.