danawoodman / module-skeleton

[NOT MAINTAINED] A clone-able starter skeleton for an NPM module using ES6/7 (via Babel) and a mocha/chai/sinon test suite. Checkout this repo, install dependencies and run "npm run" to see available tasks.

my-lib

A really cool module

Install

npm install --save my-lib

Usage

import myLib from 'my-lib'

myLib('foo') //=> 'bar'

Features

• Some
• Features...

API

A description of my module...

my-lib~hello ⇒ String

Say hello!

Kind: inner property of my-lib
Returns: String - - The welcome message

Param	Type	Description
[name]	String	The name to say hi to

Contributing

Pull requests welcome!

Please use the .editorconfig, .eslintrc configurations in your editor to ensure proper formatting.

Run the test suite with npm test and linting with npm run lint. Make sure tests are passing and that you write tests for new features and document changes to the API with updates to the JSDocs.

License

MIT © Dana Woodman