# node-module-boilerplate

> Boilerplate to kickstart creating a Node.js module

This is what I use for [my own modules](https://www.npmjs.com/~sindresorhus).

Also check out [`node-cli-boilerplate`](https://github.com/sindresorhus/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/master.tar.gz | tar -xz --strip-components=1
```

There's also a [Yeoman generator](https://github.com/sindresorhus/generator-nm).

---

**Remove everything from here and above**

---

# unicorn-fun

> My awesome module

## Install

```
$ npm install unicorn-fun
```

## Usage

```js
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.

# node-module-boilerplate

> Boilerplate to kickstart creating a Node.js module

This is what I use for [my own modules](https://www.npmjs.com/~sindresorhus).

Also check out [`node-cli-boilerplate`](https://github.com/sindresorhus/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
```

There's also a [Yeoman generator](https://github.com/sindresorhus/generator-nm).

---

**Remove everything from here and above**

---

# unicorn-fun

> My awesome module

## Install

```
$ npm install unicorn-fun
```

## Usage

```js
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.

Rename `master` branch to `main`
Rename `master` branch to `main`
