template-lib/README.md

Scaffold a Javascript library

<h1 align="center">template-lib</h1>
<div align="center">
  <strong>Scaffold a Javascript library</strong>
</div>
<br>
<div align="center">
  <a href="https://npmjs.org/package/template-lib">
    <img src="https://img.shields.io/npm/v/template-lib.svg?style=flat-square" alt="Package version" />
  </a>
  <a href="https://npmjs.org/package/template-lib">
  <img src="https://img.shields.io/npm/dm/template-lib.svg?style=flat-square" alt="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" />
  </a>
  <a href="https://travis-ci.org/tiaanduplessis/template-lib">
    <img src="https://img.shields.io/travis/tiaanduplessis/template-lib.svg?style=flat-square" alt="Travis Build" />
  </a>
  <a href="https://github.com/tiaanduplessis/template-lib/blob/master/LICENSE">
    <img src="https://img.shields.io/npm/l/template-lib.svg?style=flat-square" alt="License" />
  </a>
  <a href="http://makeapullrequest.com">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs" />
  </a>
	  <a href="https://greenkeeper.io/">
    <img src="https://badges.greenkeeper.io/tiaanduplessis/template-lib.svg" alt="Greenkeeper" />
  </a>
</div>
<br>
<div align="center">
  <a href="https://github.com/tiaanduplessis/template-lib/watchers">
    <img src="https://img.shields.io/github/watchers/tiaanduplessis/template-lib.svg?style=social" alt="Github Watch Badge" />
  </a>
  <a href="https://github.com/tiaanduplessis/template-lib/stargazers">
    <img src="https://img.shields.io/github/stars/tiaanduplessis/template-lib.svg?style=social" alt="Github Star Badge" />
  </a>
  <a href="https://twitter.com/intent/tweet?text=Check%20out%20template-lib!%20https://github.com/tiaanduplessis/template-lib%20%F0%9F%91%8D">
    <img src="https://img.shields.io/twitter/url/https/github.com/tiaanduplessis/template-lib.svg?style=social" alt="Tweet" />
  </a>
</div>
<br>
<div align="center">
  Built with ❤︎ by <a href="https://github.com/tiaanduplessis">Tiaan</a> and <a href="https://github.com/tiaanduplessis/template-lib/graphs/contributors">contributors</a>
</div>

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

## About


Module contains a template for scaffolding out a module using [sao](https://sao.js.org/#/).
It includes:

- [jest](https://github.com/facebook/jest) (Optional) - 🃏 Delightful JavaScript Testing
- [standard](https://github.com/feross/standard) - JavaScript Style Guide, with linter & automatic code fixer
- [prettier](https://github.com/prettier/prettier) - opinionated JavaScript formatter
- [husky](https://github.com/typicode/husky) - 🐶 Git hooks made easy
- [bili](https://github.com/egoist/bili) (Optional) - Bundle JS library with a single command

## Install

After installing [sao](https://github.com/egoist/sao):

From git:

```sh
$ sao tiaanduplessis/template-lib
```

From npm:

```sh
$ sao lib
```

## Contribute

Contributions are welcome. Please open up an issue or create PR if you would like to help out.

## License

Licensed under the MIT License.