Contents

# Sidekiq::Workflow

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'sidekiq-workflow'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install sidekiq-workflow

## Usage

TODO: Write usage instructions here

## Development

sidekiq-workflow is being developed in tandom with a series of tutorials on the process of [developing a rails gem](https://badmonkeydev.wordpress.com/2015/06/04/how-to-build-your-own-ruby-gem-from-start-to-finish/).  Feel free to follow along or to use the series as a means of coming up to speed on the code.

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sidekiq-workflow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

Please also take a look at [this post](https://badmonkeydev.wordpress.com/2015/05/23/code-review-best-practices/) for guidlines on submitting pull requests.  Thanks!


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
sidekiq-workflow-0.0.1	README.md