template-lib/template/README.md

Scaffold a Javascript library

<% const camelcasedName = this.camelcase(name) -%>
<% const normalUserName = username.toLowerCase() -%>

<h1 align="center"><%= name %></h1>
<div align="center">
  <strong><%= description %></strong>
</div>
<br>
<div align="center">
  <a href="https://npmjs.org/package/<%= name %>">
    <img src="https://img.shields.io/npm/v/<%= name %>.svg?style=flat-square" alt="npm package version" />
  </a>
  <a href="https://npmjs.org/package/<%= name %>">
  <img src="https://img.shields.io/npm/dm/<%= name %>.svg?style=flat-square" alt="npm downloads" />
  </a>
  <a href="https://github.com/feross/standard">
    <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square" alt="standard JS linter" />
  </a>
  <a href="https://github.com/prettier/prettier">
    <img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square" alt="prettier code formatting" />
  </a>
  <a href="https://travis-ci.org/<%= normalUserName %>/<%= name %>">
    <img src="https://img.shields.io/travis/<%= normalUserName %>/<%= name %>.svg?style=flat-square" alt="travis ci build status" />
  </a>
  <a href="https://github.com/<%= normalUserName %>/<%= name %>/blob/master/LICENSE">
    <img src="https://img.shields.io/npm/l/<%= name %>.svg?style=flat-square" alt="project license" />
  </a>
  <a href="http://makeapullrequest.com">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="make a pull request" />
  </a>
</div>
<br>
<div align="center">
  <a href="https://github.com/<%= normalUserName %>/<%= name %>/watchers">
    <img src="https://img.shields.io/github/watchers/<%= normalUserName %>/<%= name %>.svg?style=social" alt="Github Watch Badge" />
  </a>
  <a href="https://github.com/<%= normalUserName %>/<%= name %>/stargazers">
    <img src="https://img.shields.io/github/stars/<%= normalUserName %>/<%= name %>.svg?style=social" alt="Github Star Badge" />
  </a>
  <a href="https://twitter.com/intent/tweet?text=Check%20out%20<%= name %>!%20https://github.com/<%= normalUserName %>/<%= name %>%20%F0%9F%91%8D">
    <img src="https://img.shields.io/twitter/url/https/github.com/<%= normalUserName %>/<%= name %>.svg?style=social" alt="Tweet" />
  </a>
</div>
<br>
<div align="center">
  Built with ❤︎ by <a href="https://github.com/<%= normalUserName %>"><%= username %></a> and <a href="https://github.com/<%= normalUserName %>/<%= name %>/contributors">contributors</a>
</div>

<h2>Table of Contents</h2>
<details>
  <summary>Table of Contents</summary>
  <li><a href="#install">Install</a></li>
  <li><a href="#usage">Usage</a></li>
  <li><a href="#contribute">Contribute</a></li>
  <li><a href="#license">License</a></li>
</details>

## Install

```sh
$ npm install <%= name %>
# OR
$ yarn add <%= name %>
```

## Usage

```js
const <%= camelcasedName %> = require('<%= name %>')

<%= camelcasedName %>()
```

## Contributing

Contributions are welcome!

1. Fork it.
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

Or open up [a issue](https://github.com/<%= normalUserName %>/<%= name %>/issues).

## License

Licensed under the MIT License.