dark-side/README.md

Let the dark side manage your something

Dark Side
=========

[![NPM version][npm-image]][npm-url] [![Build Status](https://travis-ci.org/Mindera/dark-side.svg?branch=master)](https://travis-ci.org/Mindera/dark-side)

Dark Side is a tool for managing pools of objects. You can import Dark Side in your NodeJS project and manage multiple pools, organised by characteristics and multiple profiles.

## TODO

 **Warning: This is still in development, this is not production ready!**

  * Complete unit tests for bootstrapping Dark Side
  * Integrate with Travis
  * Clean code
  * Improve logging
  * Add documentation

## Installation

### NPM

  npm install dark-side --save

## Usage

  TBD

## Build
  
  grunt clean && grunt

## Tests

  npm test
  
## Future work

  * Support other exports besides Node and AMD
  * Adding support for pattern matching inside the feature properties

## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Lint and test your code.

## Release History

  * 0.0.1 - Initial release

[npm-url]: https://npmjs.org/package/dark-side
[npm-image]: https://badge.fury.io/js/dark-side.svg