simplekiss 0.0.0 → 0.1.0

data/LICENSE

@@ -1,20 +1,22 @@
-Copyright (c) 2009 Jamie Lawrence
+ Copyright (c) 2010 Jamie Lawrence. See LICENSE for details.
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+ Permission is hereby granted, free of charge, to any person
+ obtaining a copy of this software and associated documentation
+ files (the "Software"), to deal in the Software without
+ restriction, including without limitation the rights to use,
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following
+ conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,17 +1,48 @@
 = simplekiss
 
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+This is a simple library to add KISSmetrics to your layouts. It is configured using a YAML file.
+
+== Install
+
+gem install simplekiss
+
+== Configure
+
+Create a kissmetrics.yml file in your app's config/ dir
+
+    #KISSmetrics configuration file.
+    ---
+    apikey: <enter your api key here>
+
+    <controller>:
+      <action>: 'kissmetrics step title'
+      <another action>: 'kissmetrics step title'
+
+    # Example usage
+    user:
+      new: 'Visit signup page'
+      show: 'Viewed account page'
+    post:
+      new: 'Create a new post'
+
+This allows you the customise the name of the action based on the controller and action being called
+
+== Adding KISSmetrics to your layout
+
+Simply add this to the end of your layout, preferably the last thing before <\body>
+
+    <%= kissmetrics if Rails.env == 'production' %>
+
+By default, if an entry isn't found '<controller name>/<action name>' is sent to KISSmetrics instead.
+If you want to turn off this behaviour, to stop polluting you stats with every page:
+
+    <%= kissmetrics(use_defaults=>false) if Rails.env == 'production' %>
+
+
+== TODO/Feedback
+ * Tests: yeah, I know. Feel free to help me out here
+
 
 == Copyright
 
-Copyright (c) 2010 Jamie Lawrence. See LICENSE for details.
+ Copyright (c) 2010 Jamie Lawrence. See LICENSE for details (MIT licence).

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/simplekiss.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplekiss}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jamie Lawrence"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplekiss
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jamie Lawrence