Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added INSTALL to display config info when the plugin is installed.

  • Loading branch information...
commit 6c000e7e6b4ba9ee74368397b1926a549d32d409 1 parent 7220d02
@jyurek jyurek authored
Showing with 26 additions and 1 deletion.
  1. +25 −0 INSTALL
  2. +1 −1  README.rdoc
View
25 INSTALL
@@ -0,0 +1,25 @@
+=== Configuration
+
+You should have something like this in config/initializers/hoptoad.rb.
+
+ HoptoadNotifier.configure do |config|
+ config.api_key = '1234567890abcdef'
+ end
+
+(Please note that this configuration should be in a global configuration, and
+is *not* environment-specific. Hoptoad is smart enough to know what errors are
+caused by what environments, so your staging errors don't get mixed in with
+your production errors.)
+
+You can test that Hoptoad is working in your production environment by using
+this rake task (from RAILS_ROOT):
+
+ rake hoptoad:test
+
+If everything is configured properly, that task will send a notice to Hoptoad
+which will be visible immediately.
+
+NOTE FOR RAILS 1.2.* USERS:
+
+You will need to copy the hoptoad_notifier_tasks.rake file into your
+RAILS_ROOT/lib/tasks directory in order for the rake hoptoad:test task to work.
View
2  README.rdoc
@@ -30,7 +30,7 @@ from your project's RAILS_ROOT, run:
=== Configuration
-you should have something like this in config/initializers/hoptoad.rb.
+You should have something like this in config/initializers/hoptoad.rb.
HoptoadNotifier.configure do |config|
config.api_key = '1234567890abcdef'
Please sign in to comment.
Something went wrong with that request. Please try again.