Contents

Vanity is an Experiment Driven Development framework for Rails.

* All about Vanity: http://vanity.labnotes.org
* On github: http://github.com/assaf/vanity
* Vanity requires Redis 1.0 or later.

http://farm3.static.flickr.com/2540/4099665871_497f274f68_o.jpg


== A/B Testing With Rails (In 5 Easy Steps)

<b>Step 1:</b> Start using Vanity in your Rails application:

  gem.config "vanity"

And:

  class ApplicationController < ActionController::Base
    use_vanity :current_user
  end

<b>Step 2:</b> Define your first A/B test.  This experiment goes in the file <code>experiments/price_options.rb</code>:

  ab_test "Price options" do
    description "Mirror, mirror on the wall, who's the better price of all?"
    alternatives 19, 25, 29
    metrics :signups
  end

<b>Step 3:</b> Present the different options to your users:

  <h2>Get started for only $<%= ab_test :price_options %> a month!</h2>

<b>Step 4:</b> Measure conversion:

  class SignupController < ApplicationController
    def signup
      @account = Account.new(params[:account])
      if @account.save
        track! :signups
        redirect_to @acccount
      else
        render action: :offer
      end
    end
  end

<b>Step 5:</b> Check the report:

  vanity --output vanity.html


== Building From Source

To run the test suite for the first time:

  $ gem install rails mocha timecop
  $ rake

You can also +rake test+ if you insist on being explicit.

To build the documentation:
 
  $ gem install yardoc jekyll
  $ rake docs
  $ open html/index.html

To clean up after yourself:

  $ rake clobber

To package Vanity as a gem and install on your machine:

  $ rake install


== Credits/License

Original code, copyright of Assaf Arkin, released under the MIT license.  

Documentation available under the Creative Commons Attribution license.

For full list of credits and licenses: http://vanity.labnotes.org/credits.html.

Version data entries

4 entries across 4 versions & 2 rubygems

Version	Path
mikeg-vanity-1.3.0	README.rdoc
vanity-1.2.0	README.rdoc
vanity-1.1.1	README.rdoc
vanity-1.1.0	README.rdoc