Skip to content

Commit

Permalink
Removing INSTALL and making sure the testing and license file show up
Browse files Browse the repository at this point in the history
  • Loading branch information
qrush authored and Joe Ferris committed Nov 5, 2009
1 parent 5e7a896 commit df14a50
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 64 deletions.
3 changes: 3 additions & 0 deletions .yardopts
@@ -0,0 +1,3 @@
-
TESTING.rdoc
MIT-LICENSE
55 changes: 0 additions & 55 deletions INSTALL

This file was deleted.

2 changes: 1 addition & 1 deletion README.rdoc
Expand Up @@ -44,7 +44,7 @@ be aggregated, filtered, sorted, analyzed, massaged, and searched. In previous
releases you had to include HoptoadNotifier::Catcher into your releases you had to include HoptoadNotifier::Catcher into your
ApplicationController, but the plugin takes care of that now. 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 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: RAILS_ROOT/lib/tasks directory in order for the following to work:
Expand Down
1 change: 1 addition & 0 deletions Rakefile
Expand Up @@ -23,6 +23,7 @@ end
begin begin
require 'yard' require 'yard'
YARD::Rake::YardocTask.new do |t| YARD::Rake::YardocTask.new do |t|
t.files = ['lib/**/*.rb', 'TESTING.rdoc']
end end
rescue LoadError rescue LoadError
end end
8 changes: 0 additions & 8 deletions TESTING

This file was deleted.

8 changes: 8 additions & 0 deletions 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+
1 change: 1 addition & 0 deletions lib/hoptoad_notifier.rb
Expand Up @@ -82,6 +82,7 @@ def configure
# #
# @param [Exception] exception The exception you want to notify Hoptoad about. # @param [Exception] exception The exception you want to notify Hoptoad about.
# @param [Hash] opts Data that will be sent to Hoptoad. # @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] :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] :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+. # @option opts [String] :backtrace A backtrace, usually obtained with +caller+.
Expand Down

0 comments on commit df14a50

Please sign in to comment.