README.rdoc in mitamirri-0.13.8 vs README.rdoc in mitamirri-2.0.8

- old
+ new

@@ -1,77 +1,32 @@ = mitamirri -Mitamirri is still in development and will not be production-ready until version 1.0. +Mitamirri is a Rails engine designed to be a drop-in substitute for (or companion to) Google Analytics that allows tracking of custom user events at a very granular level (e.g. specific link or button clicks and even mouseovers) in addition to the standard visits, etc. -It's a Rails engine designed to be a drop-in substitute for (or companion to) Google Analytics that allows tracking of custom user events at a very granular level (e.g. specific link or button clicks and even mouseovers) in addition to the standard visits, etc. It uses MongoDB on the backend for optimal performance, even with hundreds of thousands of visits, and to stay out of the way of your application's database. - == Installation -* Make sure that you have MongoDB installed and configured for your environment. - - * See http://www.mongodb.org/display/DOCS/Quickstart - - * For the development environment, this OSX-specific installation guide is useful: http://shiftcommathree.com/articles/how-to-install-mongodb-on-os-x - - * Install the mongo_mapper: - - gem install mongo_mapper - - * Install mongo_mapper's dependency: - - gem install bson_ext - -* Make sure that you have the Jeweler gem installed: - - gem install jeweler - -* Install the gem. From the Mitamirri repo: - - rake install - * Add the following lines to your config/environment.rb file: - config.gem 'bantik-user-agent', :lib => 'user-agent' config.gem 'mitamirri' - config.gem 'mongo_mapper' - config.gem 'pdfkit' - config.gem 'seer' -* Add the following line to your application's Rakefile: - - require 'mitamirri/tasks' - * Add this to the top of your app/helpers/application_helper.rb file: include Mitamirri::Helper * To install the necessary files into your application, run: rake mitamirri:install -* Update the database name in config/initializers/database.rb with the name of your application. Be sure to remove the timestamp from the database name! - * If you want to override default behaviour (strongly recommended, to at least require authorization for accessing reports), run the following rake command to copy Mitamirri's views and controllers to your application for customization: rake mitamirri:override -* Mitamirri will automatically detect the host application's ability to render PDF versions of reports. To enable PDF output of reports, install PDFKit on your system add the following lines to your environment.rb file: +* Include Mitamirri's CSS in your admin layout: - config.gem 'pdfkit' - config.gem 'geokit' - config.gem 'user-agent' - config.gem 'bantik-user-agent', :lib => 'user-agent' - config.middleware.use "PDFKit::Middleware", :print_media_type => true + <link href="/stylesheets/mitamirri.css" media="all" rel="stylesheet" type="text/css" /> + <link href="/stylesheets/mitamirri_print.css" media="print" rel="stylesheet" type="text/css" /> -* Recommended for optimal PDF output: add the following rule to your application's print style sheet: - - .page_break { display: block; text-align: center; margin-top: 2em; page-break-after: always; } - - And the following to your screen style sheet: - - .page_break { display: none; } - == Configuring Tracking * To track pageviews, add this anywhere in the HTML body of your view (or layout) file: <%= track_action 'view' -%> @@ -96,18 +51,14 @@ <%= track_action 'clickthrough', :observe => 'my_link_id', :label => 'Link to CorporateSite.com' -%> == Accessing Reports -To view reports and session details, point your browser to http://localhost:3000/tracking/ +To view reports and session details, point your browser to http://localhost:3000/admin/tracking/ == Development Tips -* To run specs, use spec spec/ - -* If you're just changing views, run rake:install from your local Mitamirri directory and updates will appear in your host application immediately. - -* If you're changing models, run rake:install and then restart your host application. +* To run specs, use rspec spec/ * If you add features, run rake version:bump:minor to adjust the version number accordingly. * If you're just fixing bugs, run rake version:bump:patch instead.