Permalink
Browse files

Update sidekiq and improve readme/gemspec

  • Loading branch information...
1 parent abd84b1 commit de7dba51040d6aacb88790fd7e24d578f9e015a4 @mhfs committed Aug 24, 2012
Showing with 25 additions and 13 deletions.
  1. +0 −3 Gemfile
  2. +22 −6 README.md
  3. +3 −4 sidekiq-failures.gemspec
View
@@ -2,6 +2,3 @@ source 'https://rubygems.org'
# Specify your gem's dependencies in sidekiq-failures.gemspec
gemspec
-
-# FIXME remove once tabs support is released
-gem "sidekiq", github: "mperham/sidekiq"
View
@@ -1,30 +1,46 @@
# Sidekiq::Failures
Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you browse
-them. Makes use of Sidekiq's custom tabs and middlewares.
+them. Makes use of Sidekiq's custom tabs and middleware chain.
+
+It mimics the way Resque keeps track of failures.
Note that each failed retry will create a new failed job. This might result in a
-prety big failures list. Think twice before using this project. In most cases
-automatic retries allied with exception notifications will be enough.
+pretty big failures list. Think twice before using this project. In most cases
+automatic retries allied to exception notifications will be enough.
+
+## Important Note!
+
+This is an ongoing, alpha level project. Be prepared that the API might change and bugs might occur.
## Installation
Add this line to your application's Gemfile:
- gem 'sidekiq-failures'
+```ruby
+gem 'sidekiq-failures'
+```
-And then execute:
+## Dependencies
- $ bundle
+Depends on Sidekiq >= 2.2.1
## Usage
Simply having the gem in your Gemfile should be enough.
+Your failed jobs will be visible via a Failures tab in the Web UI.
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## License
+
+Released under the MIT License. See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/mhfs/sidekiq-failures/blob/master/LICENSE
View
@@ -4,8 +4,8 @@ require File.expand_path('../lib/sidekiq/failures/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ["Marcelo Silveira"]
gem.email = ["marcelo@mhfs.com.br"]
- gem.description = %q{Keep track of Sidekiq failed jobs and add a tab to the Web UI to let you browse and manually retry them}
- gem.summary = %q{Keep track of Sidekiq failed jobs and add a tab to the Web UI to let you browse and manually retry them}
+ gem.description = %q{Keep track of Sidekiq failed jobs}
+ gem.summary = %q{Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you browse them. Makes use of Sidekiq's custom tabs and middleware chain.}
gem.homepage = "https://github.com/mhfs/sidekiq-failures/"
gem.files = `git ls-files`.split($\)
@@ -15,8 +15,7 @@ Gem::Specification.new do |gem|
gem.require_paths = ["lib"]
gem.version = Sidekiq::Failures::VERSION
- # FIXME uncomment once tab support is released
- # gem.add_dependency "sidekiq"
+ gem.add_dependency "sidekiq", ">= 2.2.1"
gem.add_dependency "slim"
gem.add_dependency "sinatra"
gem.add_dependency "sprockets"

0 comments on commit de7dba5

Please sign in to comment.