Short blurb about what your product does.

One to two paragraph statement about your product and what it does.

OS X & Linux:

npm install my-crazy-module --save

Windows:

edit autoexec.bat

A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.

For more examples and usage, please refer to the Wiki.

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

make install
npm test

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Remove setDefaultXYZ()
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
• 0.1.0
  • The first proper release
  • CHANGE: Rename foo() to bar()
• 0.0.1
  • Work in progress

Your Name – @YourTwitter – [email protected]

Distributed under the XYZ license. See LICENSE for more information.

https://github.com/yourname/github-link

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request