Permalink
Browse files

Updated documentation.

  • Loading branch information...
1 parent 116d238 commit ef6f4a570cc9fef9ccd386be41115dfb51810fc7 @myronmarston committed Oct 21, 2009
Showing with 22 additions and 5 deletions.
  1. +20 −3 README.rdoc
  2. +2 −2 Rakefile
View
@@ -1,6 +1,24 @@
= email_blacklist
-Description goes here.
+Blacklist particular email addresses so ActionMailer doesn't deliver emails to them.
+
+This is useful in a variety of situations:
+* You can blacklist an entire domain.
+* You can stop emails from being sent to users who have deactivated their accounts with your app.
+* Any other reason you might want to stop emails from being sent...
+
+== Installation
+ gem install email_blacklist
+
+== Configuration
+
+Blacklisting is as easy as:
+
+ EmailBlacklist::Config.blacklist do |email_address|
+ # return true if emails should not be sent to this email address.
+ end
+
+The block you provide will be called with every email address used by any ActionMailer email. This includes to, cc and bcc addresses.
== Note on Patches/Pull Requests
@@ -9,8 +27,7 @@ Description goes here.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
- (if you want to have your own version, that is fine but
- bump version in a commit by itself I can ignore when I pull)
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
== Copyright
View
@@ -5,8 +5,8 @@ begin
require 'jeweler'
Jeweler::Tasks.new do |gem|
gem.name = "email_blacklist"
- gem.summary = %Q{TODO: one-line summary of your gem}
- gem.description = %Q{TODO: longer description of your gem}
+ gem.summary = %Q{Ensure no emails are ever sent to particular email addresses.}
+ gem.description = %Q{Blacklist particular email addresses so ActionMailer doesn't deliver emails to them.}
gem.email = "myron.marston@gmail.com"
gem.homepage = "http://github.com/myronmarston/email_blacklist"
gem.authors = ["Myron Marston"]

0 comments on commit ef6f4a5

Please sign in to comment.