Symro/README-template

A template for READMEs

Project Name

Description.

Installation

$ npm install username/project-name

Usage

var ProjectName = require('project-name')
var projectName = new ProjectName()

// YOUR CODE

API

» ProjectName.method()

…description.

projectName.method() // "result"

» ProjectName.anotherMethod()

…description.

projectName.anotherMethod() // "result"

---

Changelog

License