Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Removing INSTALL and making sure the testing and license file show up

  • Loading branch information...
commit df14a5046d913d0ede30d8b72f39e073f39f0286 1 parent 5e7a896
@qrush qrush authored Joe Ferris committed
View
3  .yardopts
@@ -0,0 +1,3 @@
+-
+TESTING.rdoc
+MIT-LICENSE
View
55 INSTALL
@@ -1,55 +0,0 @@
-HoptoadNotifier
-===============
-
-This is the notifier plugin for integrating apps with Hoptoad.
-
-When an uncaught exception occurs, HoptoadNotifier will POST the relevant data
-to the Hoptoad server specified in your environment.
-
-
-INSTALLATION
-------------
-
-REMOVE EXCEPTION_NOTIFIER
-
-In your ApplicationController, REMOVE this line:
-
- include ExceptionNotifiable
-
-In your config/environment* files, remove all references to ExceptionNotifier
-
-Remove the vendor/plugins/exception_notifier directory.
-
-INSTALL HOPTOAD_NOTIFIER
-
-From your project's RAILS_ROOT, run:
-
- script/plugin install git://github.com/thoughtbot/hoptoad_notifier.git
-
-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* enrivonment-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.)
-
-After this is in place, all exceptions will be logged to Hoptoad where they can
-be aggregated, filtered, sorted, analyzed, massaged, and searched.
-
-** 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 following to work:
-
-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.
View
2  README.rdoc
@@ -44,7 +44,7 @@ be aggregated, filtered, sorted, analyzed, massaged, and searched. In previous
releases you had to include HoptoadNotifier::Catcher into your
ApplicationController, but the plugin takes care of that now.
-*NOTE FOR RAILS 1.2.* USERS:*
+=== 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 following to work:
View
1  Rakefile
@@ -23,6 +23,7 @@ end
begin
require 'yard'
YARD::Rake::YardocTask.new do |t|
+ t.files = ['lib/**/*.rb', 'TESTING.rdoc']
end
rescue LoadError
end
View
8 TESTING
@@ -1,8 +0,0 @@
-For Maintainers:
-
-When developing the Hoptoad Notifier, be sure to use the integration test
-against an existing project on staging before pushing to master.
-
-./script/integration_test.rb <test project's api key> <staging server hostname>
-./script/integration_test.rb <test project's api key> <staging server hostname> secure
-
View
8 TESTING.rdoc
@@ -0,0 +1,8 @@
+= For Maintainers:
+
+When developing the Hoptoad Notifier, be sure to use the integration test
+against an existing project on staging before pushing to master.
+
++./script/integration_test.rb <test project's api key> <staging server hostname>+
+
++./script/integration_test.rb <test project's api key> <staging server hostname> secure+
View
1  lib/hoptoad_notifier.rb
@@ -82,6 +82,7 @@ def configure
#
# @param [Exception] exception The exception you want to notify Hoptoad about.
# @param [Hash] opts Data that will be sent to Hoptoad.
+ #
# @option opts [String] :api_key The API key for this project. The API key is a unique identifier that Hoptoad uses for identification.
# @option opts [String] :error_message The error returned by the exception (or the message you want to log).
# @option opts [String] :backtrace A backtrace, usually obtained with +caller+.
Please sign in to comment.
Something went wrong with that request. Please try again.