caos/README.md

A CAOS implementation for JavaScript

<h1 align="center">
  <b>caos</b>
</h1>
<div align="center">
  <!-- CI - TravisCI -->
  <a href="https://travis-ci.org/skerit/caos">
    <img src="https://img.shields.io/travis/typicode/husky/master.svg?label=Mac%20OSX%20%26%20Linux" alt="Mac/Linux Build Status" />
  </a>

  <!-- CI - AppVeyor -->
  <a href="https://ci.appveyor.com/project/skerit/caos">
    <img src="https://img.shields.io/appveyor/ci/skerit/caos/master.svg?label=Windows" alt="Windows Build status" />
  </a>

  <!-- Coverage - Codecov -->
  <a href="https://codecov.io/gh/skerit/caos">
    <img src="https://img.shields.io/codecov/c/github/skerit/caos/master.svg" alt="Codecov Coverage report" />
  </a>

  <!-- DM - Snyk -->
  <a href="https://snyk.io/test/github/skerit/caos?targetFile=package.json">
    <img src="https://snyk.io/test/github/skerit/caos/badge.svg?targetFile=package.json" alt="Known Vulnerabilities" />
  </a>

  <!-- DM - David -->
  <a href="https://david-dm.org/skerit/caos">
    <img src="https://david-dm.org/skerit/caos/status.svg" alt="Dependency Status" />
  </a>
</div>

<div align="center">
  <!-- Version - npm -->
  <a href="https://www.npmjs.com/package/caos">
    <img src="https://img.shields.io/npm/v/caos.svg" alt="Latest version on npm" />
  </a>

  <!-- License - MIT -->
  <a href="https://github.com/skerit/caos#license">
    <img src="https://img.shields.io/github/license/skerit/caos.svg" alt="Project license" />
  </a>
</div>
<br>
<div align="center">
  💣 A CAOS implementation for JavaScript
</div>
<div align="center">
  <sub>
    Coded with ❤️ by <a href="#authors">Jelle De Loecker</a>.
  </sub>
</div>


## Introduction

This repository contains a personal skeleton that I use when I publish my [npm packages](https://www.npmjs.com/~skerit).

## Install

```bash
npm install caos
```

## Usage

```js
var Caos = require('caos');
```

## Contributing
Contributions are REALLY welcome.
Please check the [contributing guidelines](.github/contributing.md) for more details. Thanks!

## Authors
- **Jelle De Loecker** -  *Follow* me on *Github* ([:octocat:@skerit](https://github.com/skerit)) and on  *Twitter* ([🐦@skeriten](http://twitter.com/intent/user?screen_name=skeriten))

See also the list of [contributors](https://github.com/skerit/caos/contributors) who participated in this project.

## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/skerit/caos/LICENSE) file for details.