readme.md

node-module-boilerplate

Boilerplate to kickstart creating a Node.js module

This is what I use for my own modules.

Also check out node-cli-boilerplate.

Getting started

Click the "Use this template" button.

Alternatively, create a new directory and then run:

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

---

Remove everything from here and above

---

unicorn-fun

My awesome module

Install

npm install unicorn-fun

Usage

import unicornFun from 'unicorn-fun';

unicornFun('unicorns');
//=> 'unicorns & rainbows'

API

unicornFun(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string
Default: 'rainbows'

Lorem ipsum.