README.rdoc in backgrounded-0.3.1 vs README.rdoc in backgrounded-0.4.1
- old
+ new
@@ -3,11 +3,11 @@
Background processing done right.
= Features
* clean and concise API
* testable
-* integrates with any background processing framework (DelayedJob, JobFu, Workling, etc)
+* integrates with any background processing framework (DelayedJob, Resque, JobFu, Workling, etc)
= Usage
#declaration
class User
@@ -23,40 +23,54 @@
= Installation
Command line installation
- sudo gem install wireframe-backgrounded
+ sudo gem install backgrounded
Rails environment.rb configuration
- config.gem 'wireframe-backgrounded', :source => 'http://gems.github.com', :lib => 'backgrounded'
+ config.gem 'backgrounded'
+Gemfile configuration
+
+ gem 'backgrounded'
+
= Configuration
Backgrounded provides a thin wrapper around any background processing framework that implements the Backgrounded handler API. This makes it trivial to swap out processing frameworks with no impact on your code.
= DelayedJob
An implementation for DelayedJob is packaged directly with Backgrounded for a slick out of the box experience.
see http://github.com/tobi/delayed_job/tree/master
- # rails config/initializers/backgrounded.rb
+ # config/initializers/backgrounded.rb
+ require 'backgrounded/handler/delayed_job_handler'
Backgrounded.handler = Backgrounded::Handler::DelayedJobHandler.new
+= Resque
+
+An implementation for Resque is packaged directly with Backgrounded for a slick out of the box experience.
+see http://github.com/defunkt/resque/
+
+ # config/initializers/backgrounded.rb
+ require 'backgrounded/handler/resque_handler'
+ Backgrounded.handler = Backgrounded::Handler::ResqueHandler.new
+
= JobFu
Developers using the JobFu library have it easy as well!
see http://github.com/jnstq/job_fu/tree
- # rails config/initializers/backgrounded.rb
+ # config/initializers/backgrounded.rb
Backgrounded.handler = JobFu::Backgrounded::Handler.new
= Custom Handlers
It's trivial to write your own plugin for processing Backgrounded events!
- # rails config/initializers/backgrounded.rb
+ # config/initializers/backgrounded.rb
class MyHandler
def request(object, method, *args)
#process the call however you want!
end
end