Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

readme, license, version

  • Loading branch information...
commit 80ece8299c1e52e8ae3e930c38a4eaed3645d246 1 parent 53a40e5
Josh Susser authored
Showing with 50 additions and 1 deletion.
  1. +20 −0 MIT-LICENSE
  2. +29 −0 README.md
  3. +1 −1  lib/resque_delivery_method/version.rb
20 MIT-LICENSE
View
@@ -0,0 +1,20 @@
+Copyright (c) 2011 Josh Susser
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 README.md
View
@@ -0,0 +1,29 @@
+# `resque_delivery_method`
+
+This gem extends ActionMailer 3.0.x with a `:resque` delivery method. If you configure your Rails 3 application to use this method, all emails will be delivered using a Resque mail queue with no need to modify individual mailer classes.
+
+## Installation
+
+To use `resque_delivery_method`, just add the gem to your application's Gemfile.
+
+## Configuration
+
+Configuration is simple.
+
+1) In `app_name/config/production.rb` set the ActionMailer delivery method:
+
+ AppName::Application.configure do
+ config.action_mailer.delivery_method = :resque
+ end
+
+2) Then set up your Resque workers to run jobs in the `resque_mailer_queue` queue.
+
+3) There is no step 3.
+
+## Credit where due
+
+This gem is based heavily on the `resque_action_mailer_backend` gem by Maurício Linhares. Unfortunately that gem only worked with Rails 2.3, and there were enough changes for Rails 3 that a new gem seemed appropriate. Thanks to Maurício for the inspiration and head start.
+
+## Copyright
+
+Copyright (c) 2011 Josh Susser. This software is released under the MIT License.
2  lib/resque_delivery_method/version.rb
View
@@ -1,3 +1,3 @@
module ResqueDeliveryMethod
- VERSION = "0.0.1"
+ VERSION = "0.0.0"
end
Please sign in to comment.
Something went wrong with that request. Please try again.