README.md
# [feathers-orm-service](https://github.com/Glavin001/feathers-orm-service) [![Build Status](https://travis-ci.org/Glavin001/feathers-orm-service.png?branch=master)](https://travis-ci.org/Glavin001/feathers-orm-service) [![Code Climate](https://codeclimate.com/github/Glavin001/feathers-orm-service.png)](https://codeclimate.com/github/Glavin001/feathers-orm-service)
> Easily create a Object Relational Mapping Service for Featherjs.
## Getting Started
To install feathers-orm-service from [npm](https://www.npmjs.org/), run:
```bash
$ npm install feathers-orm-service --save
```
See [Getting Started, in the docs/ directory](https://github.com/Glavin001/feathers-orm-service/blob/master/docs/Getting-Started.md).
I recommend that you also examine the [example source code in the examples/ directory](https://github.com/Glavin001/feathers-orm-service/tree/master/examples).
## Documentation
See the [docs/](docs/) directory.
## Developing
See the [lib/](lib/) directory.
### Run
```bash
grunt
```
### Testing
#### Create Database, `feathers_orm_service`
```bash
mysql -e 'create database feathers_orm_service'
```
#### Run Grunt Tests
```bash
grunt test
```
## Author
- [Glavin Wiechert](https://github.com/Glavin001)
## License
Copyright (c) 2014 Glavin Wiechert
Licensed under the [MIT license](LICENSE).