Skip to content
Browse files

More docs

  • Loading branch information...
1 parent 577aa0b commit 9c7786d794c47b00cc452919854c65815f527b7f @iconara committed Apr 2, 2010
Showing with 19 additions and 3 deletions.
  1. +2 −2 .gitignore
  2. +1 −0 Gemfile
  3. +1 −1 Rakefile
  4. +15 −0 lib/snogmetrics.rb
View
4 .gitignore
@@ -15,10 +15,10 @@ tmtags
## PROJECT::GENERAL
/coverage
-/rdoc
-/yardoc
+/doc
/coverage
/pkg
/.bundle
+/.yardoc
## PROJECT::SPECIFIC
View
1 Gemfile
@@ -4,6 +4,7 @@ group :development do
gem 'rake'
gem 'jeweler'
gem 'yard'
+ gem 'BlueCloth'
gem 'rails', '>= 2.3.5'
end
View
2 Rakefile
@@ -38,7 +38,7 @@ begin
require 'yard'
YARD::Rake::YardocTask.new
rescue LoadError
- task :yardoc do
+ task :yard do
abort 'YARD is not available. In order to run yardoc, you must: sudo gem install yard'
end
end
View
15 lib/snogmetrics.rb
@@ -1,3 +1,18 @@
+# If SNOGmetrics is used as a Rails plugin, this module is automatically mixed
+# into ActionController::Base, so that it's #km method is available in
+# controllers and in views.
+#
+# If not used as a Rails plugin, make sure that the context where Snogmetrics
+# is mixed in defines #session (which should return hash).
+#
+# You should override #kissmetrics_api_key in an initializer to set the
+# KISSmetrics API key.
+#
+# You can also override #use_fake_kissmetrics_api? to provide your own logic for
+# when the real KISSmetrics API and when the fake should be used. The fake API
+# simply outputs all events to the console (if the console is defined). The
+# the default implementation outputs the real API only when
+# `Rails.env.production?` is true.
module Snogmetrics
VERSION = '0.1.1'

0 comments on commit 9c7786d

Please sign in to comment.
Something went wrong with that request. Please try again.