visitors 0.0.2 → 0.0.3

data/README.md

@@ -1,12 +1,43 @@
 # Visitors
 
-    bundle install
-    bundle console
+The visitors gem gives you a simple tracking system for use in your
+Ruby-based web application. Anywhere in your app you can call…
 
-    Visitors::Store.new
-    Visitors::Day.new
+    Visitors.increment(1, 'show')
 
-    visitors store
-    visitors web
+…to increment a counter that corresponds to the resource with an
+identifier of 1.
 
-### Come Back Later
+## Usage
+
+First off install the gem
+
+    gem install visitors
+
+Next make sure you have Redis running and the config.yml file has the
+right configuration settings to connect to your Redis instance.
+
+    development:
+      database: postgres://localhost/visitors_development
+      redis_namespace: visitors_development
+      redis_config:
+        host: localhost
+
+You can specify which settings to use with a `VISITORS_ENV` variable.
+
+Require the visitors gem in your Rails app via your Gemfile?
+
+    gem 'visitors', '~> 0.0.2'
+
+Now add `Visitors.increment(params[:id], 'show')` to a show action in
+your application.
+
+Launch a Vegas-powered Sinatra web console to see who's been visiting
+your pages using `visitors web`.
+
+## Warning
+
+This code is likely to change a lot and probably shouldn't be used in
+your beautiful production app because of this. Feel free to fork and use
+the code but take bear in mind I make no committment to support,
+maintain or even acknowledge the existence of this small cluster fluck.

data/lib/visitors/version.rb

@@ -1,3 +1,3 @@
 module Visitors
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/visitors_spec.rb

@@ -1,14 +1,4 @@
 require 'spec_helper'
 
 describe Visitors do
-  describe '.assert_valid_field!' do
-    it 'protects against using unknown fields' do
-      error_message = %{Invalid field "invalid_field". Valid fields are []}
-
-      expect {
-        Visitors.stub!(:fields => %w[])
-        Visitors.assert_valid_field!('invalid_field')
-      }.to raise_error(Visitors::UnsupportedField, error_message)
-    end
-  end
 end

metadata

@@ -2,7 +2,7 @@
 name: visitors
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - James Conroy-Finn