mole 1.0.0 → 1.0.1

data/README.txt

@@ -5,7 +5,9 @@ The MOle
 == DESCRIPTION:
                    
 The MOle allows you to track user's interactions with your ruby application and closely monitors
-how your customers are using your application.
+how your customers are using your application. This is a must cheaper way than to hire a monitoring
+service and produces much more detailed information on your application behavior and usage. To boot
+your managers will love you !
 
 Whether you are releasing a new application or improving on an old one, it is always a good thing 
 to know if anyone is using your application and if they are, how they are using it. 
@@ -13,6 +15,16 @@ What features are your users most fond of and which features find their way into
 Using the MOle you'll be able to rapidly assess whether or not your application is a hit and if
 your coolest features are thought as such by your users. You will be able to elegantly record user
 interactions and leverage these findings for the next iteration of your application. 
+                
+The MOle was initialy released as a Rails plugin, but we found the behavior usefull in other types
+of projects such as Merb or straight up ruby applications, and decided to re-release it as a gem 
+instead.
+
+== PROJECT INFORMATION
+
+* Developer: Fernand Galiana [liquidrail.com]
+* Forum:     http://groups.google.com/group/mole-plugin
+* Home:      mole.rubyforge.org
 
 == FEATURES:
                                                                                      
@@ -39,9 +51,24 @@ The MOle allows you to easily
 
 == INSTALL:
 
-* sudo gem install mole
-
+* sudo gem install mole   
+  
 == SYNOPSIS:
+
+* The MOle can operate in 2 different modes: transient or persistent. The transient mode will
+  simply record MOle interactions within your log file. If you opt to use the 
+  persistent mode (recommanded!) which will allow to leverage the Snitch Application
+  and also draw out MOle usage reports from you database, you will need to install the 2 MOle tables in your database.
+  This is achived via the 'molify' command. In order to 'MOle' an application using the persistent
+  mode, you will need to issue the following commands:
+                                                     
+   > cd my_non_moled_application
+   > molify --up --config config/database.yml --env test
+  
+  This command will update your test database and create the MOle tables required when 
+  the MOle is in a persistent mode. Namely, these tables are mole_features and mole_logs.
+   
+  You can use molify --help to see usage information. 
                                                                                              
 * Mole initialization. This must be specified during your application initialization code.
   In a rails app, this can be set in you application controller class or environment.rb. In 
@@ -49,13 +76,13 @@ The MOle allows you to easily
         
    require 'mole'                    
    Mole.initialize( :moleable         => true,
-                    :emole_from       => "MoleBeatch@acme.com",
-                    :emole_recipients => ['fernand@acme.com'],
+                    :application      => "Smf",   
+                    :emole_from       => "MoleBeatch@liquidrail.com",
+                    :emole_recipients => ['fernand@liquidrail.com'],
                     :mode             => :persistent,
                     :log_file         => $stdout,
                     :log_level        => :debug,
                     :perf_threshold   => 2,
-                    :application      => "Smf",
                     :mole_config      => File.join( File.dirname(__FILE__), %w[mole.rb] ) )                            
                            
 * Now you'll need to create a mole.rb specification file to specify the various aspects you'll want
@@ -115,7 +142,38 @@ The MOle allows you to easily
             :boom       => boom,
             :email      => true )                               
         end     
-                             
+          
+== Snitch
+
+To view MOle interaction simply, we've created the "Snitch" a rails console application that
+allows you to see the results of your MOled application. The Snitch is a Rails 2.0 application.
+It is available at http://mole.rubyforge.org/svn/snitch/trunk/. 
+
+In order to start using the Snitch you will have to perform the following steps:
+
+* Download the Snitch
+   svn co http://mole.rubyforge.org/svn/snitch/trunk/
+   
+* The Snitch needs to access your user table to provide user related log information. So 
+  you will need to run the following rake task and provide your users table description.
+  
+  > rake setup
+  
+* Edit the Snitch database.yml to point to your application database.
+
+* Out of the box the Snitch will monitor and application named "Default". You will want
+  to match the application name that you've used in the Mole.initialize call. So you
+  should now be able to specify the following commands:
+  
+   > script/server
+   
+  Then in your browser
+  
+  http://localhost:3000?app_name=my_moled_application_name
+  
+* NOTE: You will keep enhancing the Snitch to provide capistrano deployment scripts,
+  auto application name detection and many other enhancements...
+                      
 == LICENSE:
 
 MIT Copyright (c) 2008

data/lib/mole/version.rb

@@ -2,7 +2,7 @@ module Mole
   module Version
     MAJOR = 1
     MINOR = 0
-    TINY  = 0
+    TINY  = 1
     
     # Returns the version string for the library.
     #

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: mole
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 date: 2008-03-02 00:00:00 -07:00
 summary: A flexible way to track user's interactions within your ruby web applications
 require_paths: