README.md in resque-retry-0.2.2 vs README.md in resque-retry-1.0.0.a

- old
+ new

@@ -1,26 +1,31 @@ resque-retry ============ -A [Resque][rq] plugin. Requires Resque >= 1.8.0 & [resque-scheduler][rqs]. +A [Resque][rq] plugin. Requires Resque >= 1.10.0 & [resque-scheduler][rqs] >= 1.9.9. resque-retry provides retry, delay and exponential backoff support for resque jobs. * Redis backed retry count/limit. * Retry on all or specific exceptions. * Exponential backoff (varying the delay between retrys). * Multiple failure backend with retry suppression & resque-web tab. * Small & Extendable - plenty of places to override retry logic/settings. +[![Build Status](https://secure.travis-ci.org/lantins/resque-retry.png?branch=master)](http://travis-ci.org/lantins/resque-retry) + Install & Quick Start --------------------- To install: $ gem install resque-retry +If your using [Bundler][bundler] to manage your dependencies, you should add `gem +'resque-retry'` to your projects `Gemfile`. + Add this to your `Rakefile`: require 'resque/tasks' require 'resque_scheduler/tasks' @@ -297,29 +302,29 @@ self.perform(smsc_id, mt_message) heavy_lifting end end -### Job Identifier/Key +### Job Retry Identifier/Key The retry attempt is incremented and stored in a Redis key. The key is -built using the `identifier`. If you have a lot of arguments or really long -ones, you should consider overriding `identifier` to define a more precise -or loose custom identifier. +built using the `retry_identifier`. If you have a lot of arguments or really long +ones, you should consider overriding `retry_identifier` to define a more precise +or loose custom retry identifier. -The default identifier is just your job arguments joined with a dash `-`. +The default retry identifier is just your job arguments joined with a dash `-`. By default the key uses this format: -`resque-retry:<job class name>:<identifier>`. +`resque-retry:<job class name>:<retry_identifier>`. Or you can define the entire key by overriding `redis_retry_key`. class DeliverSMS extend Resque::Plugins::Retry @queue = :mt_messages - def self.identifier(mt_id, mobile_number, message) + def self.retry_identifier(mt_id, mobile_number, message) "#{mobile_number}:#{mt_id}" end self.perform(mt_id, mobile_number, message) heavy_lifting @@ -338,5 +343,7 @@ * If you edit the gemspec/version etc, do it in another commit please. [god]: http://github.com/mojombo/god [rq]: http://github.com/defunkt/resque [rqs]: http://github.com/bvandenbos/resque-scheduler +[bundler]: http://gembundler.com/ +