README.rdoc in backgrounded-0.7.5 vs README.rdoc in backgrounded-2.0.0.pre1
- old
+ new
@@ -9,62 +9,40 @@
* integrates with any background processing framework (DelayedJob, Resque, JobFu, Workling, etc)
* background methods can be actually unit tested by using an 'in process' runner
= Usage
- #declaration
class User
- backgrounded :do_stuff
def do_stuff
- # do all your work here
end
+ def self.do_something_else
+ end
end
- #usage
user = User.new
- user.do_stuff_backgrounded
+ # execute instance method in background
+ user.backgrounded.do_stuff
+ # execute class method in background
+ User.backgrounded.do_something_else
+
= Installation
-Command line installation
-
- sudo gem install backgrounded
-
-Rails environment.rb configuration
-
- config.gem 'backgrounded'
-
Bundler Gemfile configuration
gem 'backgrounded'
= Configuration
-Backgrounded includes several configurable implementations out of the box for most popular background frameworks.
-If your framework isn't included, it's trivial to write your own implementation.
-Submit a patch and we may consider it for official distribution!
+Backgrounded packages handlers for popular frameworks in separate gems. Just drop in the gem for your particular framework or write your own!
-== DelayedJob
-see http://github.com/tobi/delayed_job/tree/master
-
- # config/initializers/backgrounded.rb
- require 'backgrounded/handler/delayed_job_handler'
- Backgrounded.handler = Backgrounded::Handler::DelayedJobHandler.new
-
== Resque
-see http://github.com/defunkt/resque/
+see http://github.com/wireframe/backgrounded-resque
- # config/initializers/backgrounded.rb
- require 'backgrounded/handler/resque_handler'
- Backgrounded.handler = Backgrounded::Handler::ResqueHandler.new
-
== JobFu
see http://github.com/jnstq/job_fu/tree
- # config/initializers/backgrounded.rb
- Backgrounded.handler = JobFu::Backgrounded::Handler.new
-
== Custom Handlers
# config/initializers/backgrounded.rb
class MyHandler
def request(object, method, *args)
@@ -73,6 +51,6 @@
end
Backgrounded.handler = MyHandler.new
== Copyright
-Copyright (c) 2009 Ryan Sonnek. See LICENSE for details.
+Copyright (c) 2012 Ryan Sonnek. See LICENSE for details.