Skip to content
This repository has been archived by the owner on Nov 11, 2017. It is now read-only.

Commit

Permalink
Added INSTALL to display config info when the plugin is installed.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jon Yurek committed Dec 1, 2009
1 parent 7220d02 commit 6c000e7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
25 changes: 25 additions & 0 deletions 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.
2 changes: 1 addition & 1 deletion README.rdoc
Expand Up @@ -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'
Expand Down

0 comments on commit 6c000e7

Please sign in to comment.