Skip to content

Commit

Permalink
refreshed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
essamhassan committed Sep 5, 2017
1 parent 468aad7 commit f7e7437
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 3 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# sneakers-rails

Integrates sneakers into your rails application with no headache.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'sneakers_rails'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install sneakers_rails

## Usage

- Run `rails g sneakers_rails:install` to install sneakers into your application
- Go to `config/initializers/sneakers.rb` and edit the file with your rabbitMQ config
- Run `rails g sneakers_rails:worker [WORKERNAME] [QUEUENAME]`

## Contributing

Bug reports and pull requests are welcome on GitHub at:
https://github.com/essamhassan/sneakers-rails


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
3 changes: 0 additions & 3 deletions README.rdoc

This file was deleted.

0 comments on commit f7e7437

Please sign in to comment.