README in exception_notification-2.3.3.0 vs README in exception_notification-2.4.0

@@ -11,76 +11,17 @@
 The email includes information about the current request, session, and
 environment, and also gives a backtrace of the exception.
 
 == Usage
 
-First, include the ExceptionNotifiable mixin in whichever controller you want
-to generate error emails (typically ApplicationController):
+As of Rails 3 ExceptionNotifier is used as a rack middleware
 
-  class ApplicationController < ActionController::Base
-    include ExceptionNotification::Notifiable
-    ...
-  end
+  Whatever::Application.config.middleware.use ExceptionNotifier,
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <[e-mail]>},
+    :exception_recipients => %w{[e-mail]}
 
-Then, specify the email recipients in your environment:
-
-  ExceptionNotification::Notifier.exception_recipients = %w([e-mail] [e-mail])
-
-And that's it! The defaults take care of the rest.
-
-== Configuration
-
-You can tweak other values to your liking, as well. In your environment file,
-just set any or all of the following values:
-
-  # defaults to [e-mail]
-  ExceptionNotification::Notifier.sender_address =
-    %("Application Error" <[e-mail]>)
-
-  # defaults to "[ERROR] "
-  ExceptionNotification::Notifier.email_prefix = "[APP] "
-
-Even if you have mixed into ApplicationController you can skip notification in
-some controllers by
-  
-  class MyController  < ApplicationController
-    skip_exception_notifications
-  end
-  
-== Deprecated local_request? overriding
-
-Email notifications will only occur when the IP address is determined not to
-be local. You can specify certain addresses to always be local so that you'll
-get a detailed error instead of the generic error page. You do this in your
-controller (or even per-controller):
-
-  consider_local "64.72.18.143", "14.17.21.25"
-
-You can specify subnet masks as well, so that all matching addresses are
-considered local:
-
-  consider_local "64.72.18.143/24"
-
-The address "127.0.0.1" is always considered local. If you want to completely
-reset the list of all addresses (for instance, if you wanted "127.0.0.1" to
-NOT be considered local), you can simply do, somewhere in your controller:
-
-  local_addresses.clear
-
-NOTE: The above functionality has has been pulled out to consider_local.rb,
-as interfering with rails local determination is orthogonal to notification, 
-unnecessarily clutters backtraces, and even occasionally errs on odd ip or 
-requests bugs. To return original functionality add an initializer with:
- 
-  ActionController::Base.send :include, ConsiderLocal
-
-or just include it per controller that wants it
-
- class MyController  < ApplicationController
-   include ExceptionNotification::ConsiderLocal
- end
-
 == Customization
 
 By default, the notification email includes four parts: request, session,
 environment, and backtrace (in that order). You can customize how each of those
 sections are rendered by placing a partial named for that part in your
@@ -88,53 +29,53 @@
 access to the following variables:
 
 * @controller: the controller that caused the error
 * @request: the current request object
 * @exception: the exception that was raised
-* @host: the name of the host that made the request
 * @backtrace: a sanitized version of the exception's backtrace
-* @rails_root: a sanitized version of RAILS_ROOT
 * @data: a hash of optional data values that were passed to the notifier
 * @sections: the array of sections to include in the email
 
 You can reorder the sections, or exclude sections completely, by altering the
-ExceptionNotification::Notifier.sections variable. You can even add new sections that
+ExceptionNotifier.sections variable. You can even add new sections that
 describe application-specific data--just add the section's name to the list
 (whereever you'd like), and define the corresponding partial. Then, if your
 new section requires information that isn't available by default, make sure
 it is made available to the email using the exception_data macro:
 
   class ApplicationController < ActionController::Base
+    before_filter :log_additional_data
     ...
     protected
-      exception_data :additional_data
-
-      def additional_data
-        { :document => @document,
-          :person => @person }
+      def log_additional_data
+        request.env["exception_notifier.exception_data"] = {
+          :document => @document,
+          :person => @person
+        }
       end
     ...
   end
 
 In the above case, @document and @person would be made available to the email
 renderer, allowing your new section(s) to access and display them. See the
 existing sections defined by the plugin for examples of how to write your own.
 
-== 404s errors
+== Notification
 
-Notification is skipped if you return a 404 status, which happens by default 
-for an ActiveRecord::RecordNotFound or ActionController::UnknownAction error.
+After an exception notification has been delivered the rack environment variable
+'exception_notifier.delivered' will be set to +true+.
 
-== Manually notifying of error in a rescue block
+== Rails 2.3 stable and earlier
 
-If your controller action manually handles an error, the notifier will never be
-run.  To manually notify of an error call notify_about_exception from within the
-rescue block
+If you are running Rails 2.3 then see the branch for that: 
+ 
+  http://github.com/rails/exception_notification/tree/2-3-stable
 
-  def index
-    #risky operation here
-  rescue StandardError => error
-    #custom error handling here
-    notify_about_exception(error)
-  end
+If you are running pre-rack Rails then see this tag: 
 
-Copyright (c) 2005 Jamis Buck, released under the MIT license
\ No newline at end of file
+  http://github.com/rails/exception_notification/tree/pre-2-3
+
+== Support and tickets
+
+https://github.com/smartinez87/exception_notification/issues
+
+Copyright (c) 2005 Jamis Buck, released under the MIT license