@darkobits/formation/README.md

[![][travis-img]][travis-url] [![][npm-img]][npm-url] [![][deps-img]][deps-url] [![][peer-deps-img]][peer-deps-url] [![][dev-deps-img]][dev-deps-url]

[![][travis-img]][travis-url] [![][npm-img]][npm-url] [![][deps-img]][deps-url] [![][peer-deps-img]][peer-deps-url] [![][dev-deps-img]][dev-deps-url]

# formation

This is the primary package for Formation.

## Install

```bash
$ yarn add @darkobits/formation
```

or

```bash
$ npm install --save @darkobits/formation
```

## Setup

See the [official documentation](https://darkobits.gitbooks.io/formation/) for setup instructions.

[travis-img]: https://img.shields.io/travis/darkobits/formation.svg?style=flat-square
[travis-url]: https://travis-ci.org/darkobits/formation

[npm-img]: https://img.shields.io/npm/v/@darkobits/formation.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/@darkobits/formation

[deps-img]: https://david-dm.org/darkobits/formation/status.svg?path=packages/formation&style=flat-square
[deps-url]: https://david-dm.org/darkobits/formation?path=packages/formation

[peer-deps-img]: https://david-dm.org/darkobits/formation/peer-status.svg?path=packages/formation&style=flat-square
[peer-deps-url]: https://david-dm.org/darkobits/formation?path=packages%2Fformation&type=peer

[dev-deps-img]: https://david-dm.org/darkobits/formation/dev-status.svg?path=packages/formation&style=flat-square
[dev-deps-url]: https://david-dm.org/darkobits/formation?path=packages%2Fformation&type=dev