template

npm-name

This folder is a copyable template for creating new modules!

NOTE: The "files" in package.json is a whitelist you may have to add to.

When writing content for a README, keep these two guidelines in mind:

• always describe basic functionality above Installation.

• always specify a language when using code blocks.

    // examples of a language include javascript and bash
    ```[language]
      [code]
    ```

Installation

$ npm install <npm-name>

API

var Module = require('npm-name')

Module(options)

var module = Module({
  // sample options
}))

Options

• option1 - asdf. (default: true)
• option2 - cats.
• option10 - always 42.
• option9000 - epic.
  • default: this is a very long default right here

Sub Options

module.method(args)

As concisely as possible, describe the purpose of this function.

module.method(args)

existing_object.object

Object.method(args)

Add a description for this method.

existing_object.object.example(args)

Object.property

Add a description for this property.

existing_object.object.property // => example value from description

Example(s)

// Full examples go here.

MIT Licensed