Skip to content

Boilerplate to kickstart creating a Node.js module

License

Notifications You must be signed in to change notification settings

jamestalmage/node-module-boilerplate

 
 

Repository files navigation

Getting started

This is my customized version of the boilerplate. You should start with sindresorhus's original version. I've got a day job and will only be updating sporadically.

curl -fsSL https://github.com/jamestalmage/node-module-boilerplate/archive/jamestalmage.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.

About

Boilerplate to kickstart creating a Node.js module

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%