/npm-boilerplate

A boiler plate to help with spinning up NPM packages.

Primary LanguageJavaScriptISC LicenseISC

Project Name

Project description.

The Why

  • The need for the project.

Example

/* Example Description. */
example();

For more examples, check the examples dir.

# Or run the following (with node v8+):
$ node ./examples/cheatsheet.js

Installation

$ npm install package-name

Use Cases

  • Some usecases.

Keys

  • A short list of things to understand the package, better.

Notes

  • Some notes.

Development

Setup

$ sh ./setup.sh

ToDo

  • A list of ToDos.