0
@@ -1,13 +1,68 @@
0
 RailzScout
0
 ==========
0
 
0
-Introduction goes here.
0
+The RailzScout plugin implements FogBugz's BugzScout system for Rails apps.
0
+It works by submitting your bugs to your FogBugz installation directly via 
0
+HTTP post.
0
 
0
+The plugin is based on the Exception Notifier plugin by Jamis Buck. Much 
0
+works the same, but email code has been replaced with code that posts to
0
+scoutSubmit in your FogBugz installation.
0
 
0
-Example
0
-=======
0
 
0
-Example goes here.
0
+Usage
0
+=====
0
 
0
+1.  Include the ExceptionNotifiable mixin in whichever controller you want to
0
+    report errors to FogBugz. (ApplicationController for the whole app.):
0
 
0
-Copyright (c) 2008 [name of plugin creator], released under the MIT license
0
+      class ApplicationController < ActionController::Base
0
+        include ExceptionNotifiable
0
+        …
0
+
0
+2.  If you installed the plugin via default methods, you should find a 
0
+    railz_scout.rb file in your app's config/initializers/ directory.
0
+    (Otherwise, create the file or just edit environment.rb.)
0
+    You should see something like this:
0
+    
0
+      RAILZ_SCOUT_CONFIG = {
0
+        :url       => "http://example.com/FogBugz/scoutSubmit.php",
0
+      # :username  => 'RailzScout',
0
+      # :project   => 'Inbox',
0
+      # :area      => 'Undecided',
0
+      # :force_new => false,
0
+      }
0
+
0
+      RailzScout.config.merge! RAILZ_SCOUT_CONFIG
0
+
0
+   
0
+
0
+
0
+
0
+Customizations
0
+==============
0
+
0
+The rendering code from Exception Notifier has barely been touched. Therefore,
0
+the same customizations that apply to the original plugin should apply here.
0
+
0
+For more info, see their original README, included with this copy.
0
+
0
+
0
+
0
+
0
+
0
+
0
+# :title / Description
0
+# If the description field matches exactly to any other bug, this submission
0
+# will be APPENDED to that bug's history, and a new bug will NOT be created.
0
+# The occurrences field for this bug will increase by 1.
0
+
0
+# force_new / ForceNewBug
0
+# force FogBUGZ to create a new bug for this entry, instead of appending to
0
+# bug with matching description
0
+
0
+
0
+
0
+
0
+Copyright (c) 2008 Caio Chassot, released under the MIT license
0
+with parts from Exception Notifier plugin, Copyright (c) 2005 Jamis Buck, released under the MIT license