sententiaregum-flux-container/README.md

The flux implementation of the sententiaregum project based on facebook/flux

flux-container
==============

[![Build Status](https://travis-ci.org/Sententiaregum/flux-container.svg?branch=master)](https://travis-ci.org/Sententiaregum/flux-container)
[![NPM Version](https://badge.fury.io/js/sententiaregum-flux-container.svg)](https://www.npmjs.com/package/sententiaregum-flux-container)
[![Build status](https://ci.appveyor.com/api/projects/status/qk0rs9ytq2k6c2xb/branch/master?svg=true)](https://ci.appveyor.com/project/Ma27/flux-container/branch/master)

``flux-container`` is the repository which contains the isomorphic Flux implementation
used in [Sententiaregum](https://github.com/Sententiaregum/Sententiaregum) written in ES6.

## Install

You can install this package by typing:

``` shell
npm install sententiaregum-flux-container --save
```

The package requires at least ``Node 6.x`` and ``NPM 3`` is recommended.

Please keep in mind that `1.0.x` was built to use with `Sententiaregum`, it's recommended to use `2.0`.

## Contributing

Further information about contributing can be found in the [CONTRIBUTING.md](https://github.com/Sententiaregum/flux-container/blob/master/.github/CONTRIBUTING.md)

## Docs

The docs are located in the [docs/](https://github.com/Sententiaregum/flux-container/blob/master/docs) directory.

## License

Please review the [`LICENSE`](https://github.com/Sententiaregum/flux-container/blob/master/LICENSE) file that was distributed with this source code.