README.md in devise-async-0.0.1 vs README.md in devise-async-0.0.2

- old
+ new

@@ -1,6 +1,6 @@ -# Devise Async +# Devise Async [![Build Status](https://secure.travis-ci.org/mhfs/devise-async.png)](http://travis-ci.org/mhfs/devise-async) Devise Async provides an easy way to configure Devise to send its emails asynchronously using your preferred queuing backend. Supported backends: @@ -10,11 +10,13 @@ ## Installation Add this line to your application's Gemfile: - gem 'devise-async' +```ruby +gem 'devise-async' +``` And then execute: $ bundle @@ -22,18 +24,22 @@ $ gem install devise-async ## Usage -Set `DeviseAsync::Proxy` as Devise's mailer in `config/initializers/devise.rb`: +Set `Devise::Async::Proxy` as Devise's mailer in `config/initializers/devise.rb`: - # Configure the class responsible to send e-mails. - config.mailer = "DeviseAsync::Proxy" +```ruby +# Configure the class responsible to send e-mails. +config.mailer = "Devise::Async::Proxy" +``` Set your queuing backend by creating `config/initializers/devise_async.rb`: - # Supported options: :resque, :sidekiq, :delayed_job - DeviseAsync.backend = :resque +```ruby +# Supported options: :resque, :sidekiq, :delayed_job +Devise::Async.backend = :resque +``` Tip: it defaults to Resque. You don't need to create the initializer if using it. ## Contributing