README.md
# Refinery CMS Retailers
[![Build Status](https://travis-ci.org/bisscomm/refinerycms-retailers.svg?branch=master)](https://travis-ci.org/bisscomm/refinerycms-retailers) [![Code Climate](https://codeclimate.com/github/bisscomm/refinerycms-retailers/badges/gpa.svg)](https://codeclimate.com/github/bisscomm/refinerycms-retailers) [![Test Coverage](https://codeclimate.com/github/bisscomm/refinerycms-retailers/badges/coverage.svg)](https://codeclimate.com/github/bisscomm/refinerycms-retailers/coverage)
Retailers engine for [Refinery CMS](http://refinerycms.com) allows you to display retailers.
### In summary you can:
* Manage retailers
## Requirements
* [Refinery CMS](http://refinerycms.com) version 3.0.0 or above.
## Install
Open up your `Gemfile` and add at the bottom this line:
```ruby
gem 'refinerycms-retailers', github: 'bisscomm/refinerycms-retailers', branch: 'master'
```
Now, run `bundle install`
Next, to install the retailers plugin run:
rails generate refinery:retailers
Run database migrations:
rake db:migrate
Finally seed your database and you're done.
rake db:seed
## Developing & Contributing
The version of Refinery to develop this engine against is defined in the gemspec. To override the version of refinery to develop against, edit the project Gemfile to point to a local path containing a clone of refinerycms.
### Testing
Generate the dummy application to test against
$ bundle exec rake refinery:testing:dummy_app
Run the test suite with [Guard](https://github.com/guard/guard)
$ bundle exec guard start
Or just with rake spec
$ bundle exec rake spec
## More Information
* Check out our [Website](http://refinerycms.com/)
* Documentation is available in the [guides](http://refinerycms.com/guides)
* Questions can be asked on our [Google Group](http://group.refinerycms.org)
* Questions can also be asked in our IRC room, [#refinerycms on freenode](irc://irc.freenode.net/refinerycms)