payboard 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Payboard
 
-TODO: Write a gem description
+Installing this gem and adding a line to your application_controller.rb will start flowing customer events to Payboard.
 
 ## Installation
 
@@ -18,12 +18,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The fastest way to get going is to create an account at <a href="http://www.Payboard.com">www.Payboard.com</a>, add the gem (see above) and add the following code to your application_controller.rb file inside the ApplicationController class. You can get your Public API Key from the accounts tab at Payboard.
+
+after_filter :log_event
+
+def log_event
+  Payboard.log_event("Public API Key", self.controller_name + "-" + self.action_name + "-" + request.method, current_user.id) if current_user
+end
+
+This method automatically generates event names using the controller name, the action name, and the request method (get or post). You can also log events manually by adding the code above to a particular action. 
+
+Each of those parameters above are required. Here are all of the parameters that are available. 
+
+ApiKey, EventName, UserId, First (optional), Last (optional), Email (optional), CustomerId (optional), CustomerName (optional)
 
-## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/payboard/version.rb

@@ -1,3 +1,3 @@
 module Payboard
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: payboard
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-11-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70233798041340 !ruby/object:Gem::Requirement
+  requirement: &70299984246720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70233798041340
+  version_requirements: *70299984246720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70233798040920 !ruby/object:Gem::Requirement
+  requirement: &70299984246180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70233798040920
+  version_requirements: *70299984246180
 description: Payboard gem for logging events
 email:
 - matt@dyor.com