Placeholders: [project_name],[short_description],[description],[image_url],[your_x/twitter_handle],[your_email],[your_name],[license_type],[repository_url],[repository_name],[github_username]
# [project_name]
> [short_description]

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![[license_type] License][license-shield]][license-url]

[description]

![]([image_url])

## Installation

OS X & Linux:

```sh
npm install my-crazy-module --save
```

Windows:

```sh
edit autoexec.bat
```

## Usage example

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][wiki]._

## Development setup

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

```sh
make install
npm test
```

## Release History

* 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

## Meta

[your_name] – [@[your_x/twitter_handle]](https://x.com/[your_x/twitter_handle]) – [your_email]

Distributed under the [license_type] license. See ``LICENSE`` for more information.

[https://github.com/[github_username]](https://github.com/[github_username]/)

## Contributing

1. Fork it (<[repository_url]/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

<!-- Markdown link & img dfn's -->
[contributors-shield]: https://img.shields.io/github/contributors/[github_username]/[repository_name].svg?style=for-the-badge
[contributors-url]: https://github.com/[github_username]/[repository_name]/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/[github_username]/[repository_name].svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/[github_username]/[repository_name]/members
[stars-shield]: https://img.shields.io/github/stars/[github_username]/[repository_name].svg?style=for-the-badge
[stars-url]: https://github.com/[github_username]/[repository_name]/stargazers
[issues-shield]: https://img.shields.io/github/issues/[github_username]/[repository_name].svg?style=for-the-badge
[issues-url]: https://github.com/[github_username]/[repository_name]/issues
[license-shield]: https://img.shields.io/github/license/[github_username]/[repository_name].svg?style=for-the-badge
[license-url]: https://github.com/[github_username]/[repository_name]/blob/master/LICENSE.txt