lib/racknga/middleware/exception_notifier.rb in racknga-0.9.1 vs lib/racknga/middleware/exception_notifier.rb in racknga-0.9.2

@@ -18,16 +18,33 @@
 
 require 'racknga/exception_mail_notifier'
 
 module Racknga
   module Middleware
+    # This is a middleware that mails exception details on
+    # error. It's useful for finding your Rack application
+    # troubles.
+    #
+    # Usage:
+    #   require "racknga"
+    #   require "racknga/middleware/exception_notifier"
+    #
+    #   notifier_options = {
+    #     :subject_label => "[YourApplication]",
+    #     :from => "[e-mail]",
+    #     :to => "[e-mail]",
+    #   }
+    #   notifiers = [Racknga::ExceptionMailNotifier.new(notifier_options)]
+    #   use Racknga::Middleware::ExceptionNotifier, :notifiers => notifiers
+    #   run YourApplication
     class ExceptionNotifier
       def initialize(application, options={})
         @application = application
         @options = Utils.normalize_options(options || {})
         @notifiers = @options[:notifiers] || []
       end
 
+      # For Rack.
       def call(environment)
         @application.call(environment)
       rescue Exception => exception
         @notifiers.each do |notifier|
           begin