CleverStack/clever-roles

CleverStack Roles Module (RBAC)
====================
[![NPM version](https://badge.fury.io/js/clever-roles.png)](http://badge.fury.io/js/clever-roles) [![GitHub version](https://badge.fury.io/gh/cleverstack%2Fclever-roles.png)](http://badge.fury.io/gh/cleverstack%2Fclever-roles) [![Dependency Status](https://david-dm.org/CleverStack/clever-roles.png)](https://david-dm.org/CleverStack/clever-roles) [![devDependency Status](https://david-dm.org/CleverStack/clever-roles/dev-status.png)](https://david-dm.org/CleverStack/clever-roles#info=devDependencies) [![Code Climate](https://codeclimate.com/github/CleverStack/clever-roles.png)](https://codeclimate.com/github/CleverStack/clever-roles) 
[![Build Status](https://secure.travis-ci.org/CleverStack/clever-roles.png?branch=master)](https://travis-ci.org/CleverStack/clever-roles) 
[![Coverage](https://codeclimate.com/github/CleverStack/clever-roles/coverage.png)](https://codeclimate.com/github/CleverStack/clever-roles) [![NPM downloads](http://img.shields.io/npm/dm/clever-roles.png)](https://www.npmjs.org/package/clever-roles) 
[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) 

![CleverStack NodeJS ORM Module](http://cleverstack.github.io/assets/img/logos/node-seed-logo-clean.png "CleverStack NodeJS ORM Module")
<blockquote>
This CleverStack Module provides Roles for your users, use this with the clever-auth module. (This only works with ORM currently)
</blockquote>

## Documentation

See [cleverstack.io](http://cleverstack.io/documentation/#backend) for more detailed information on the Node seed or visit the [Getting Started Guide](http://cleverstack.io/getting-started/)

## Install

### CLI
1. From your project folder run `clever install clever-roles` and enter your options into the prompts
2. Run `grunt db` to rebase and seed your database.

### Manually
1. Clone this repo into your modules/clever-roles folder.
2. Add 'clever-roles' to the bundledDependencies array of your app's package.json.
3. Install the modules NPM packages.
3. Run `grunt db` to rebase and seed your database.

## License

See our [LICENSE](https://github.com/CleverStack/clever-roles/blob/master/LICENSE)