README.md in field_test-0.2.0 vs README.md in field_test-0.2.1
- old
+ new
@@ -1,14 +1,14 @@
# Field Test
:maple_leaf: A/B testing for Rails
- Designed for web and email
-- Comes with a [nice dashboard](https://fieldtest.dokkuapp.com/)
+- Comes with a [handy dashboard](https://fieldtest.dokkuapp.com/)
- Seamlessly handles the transition from anonymous visitor to logged in user
-Uses [Bayesian methods](http://www.evanmiller.org/bayesian-ab-testing.html) to evaluate results so you don’t need to choose a sample size ahead of time.
+Uses [Bayesian statistics](http://www.evanmiller.org/bayesian-ab-testing.html) to evaluate results so you don’t need to choose a sample size ahead of time.
## Installation
Add this line to your application’s Gemfile:
@@ -60,40 +60,42 @@
When an experiment is over, specify a winner:
```yml
experiments:
button_color:
- winner: red
+ winner: green
```
All calls to `field_test` will now return the winner, and metrics will stop being recorded.
## Features
You can specify a variant with query parameters to make testing easier
```
-http://localhost:3000/?field_test[button_color]=red
+?field_test[button_color]=green
```
Assign a specific variant to a user with:
```ruby
experiment = FieldTest::Experiment.find(:button_color)
-experiment.variant(participant, variant: "red")
+experiment.variant(participant, variant: "green")
```
+You can also change a user’s variant from the dashboard.
+
## Config
By default, bots are returned the first variant and excluded from metrics. Change this with:
```yml
exclude:
bots: false
```
-Keep track of when experiments started and ended. Use any format `Time.parse` accepts.
+Keep track of when experiments started and ended. Use any format `Time.parse` accepts. Variants assigned outside this window are not included in metrics.
```yml
experiments:
button_color:
started_at: Dec 1, 2016 8 am PST
@@ -118,12 +120,12 @@
button_color:
variants:
- red
- blue
weights:
- - 90
- - 10
+ - 85
+ - 15
```
If the dashboard gets slow, you can make it faster with:
```yml
@@ -132,12 +134,36 @@
This will use the Rails cache to speed up winning probability calculations.
## Funnels
-For advanced funnels, we recommend an analytics platform like [Ahoy](https://github.com/ankane/ahoy) or [Mixpanel](https://mixpanel.com/).
+You can set multiple goals for an experiment to track conversions at different parts of the funnel. First, run:
-You can use:
+```sh
+rails g field_test:events
+```
+
+And add to your config:
+
+```yml
+experiments:
+ button_color:
+ goals:
+ - signed_up
+ - ordered
+```
+
+Specify a goal during conversion with:
+
+```ruby
+field_test_converted(:button_color, goal: "ordered")
+```
+
+The results for all goals will appear on the dashboard.
+
+### Advanced
+
+For advanced funnels, we recommend an analytics platform like [Ahoy](https://github.com/ankane/ahoy) or [Mixpanel](https://mixpanel.com/). You can use:
```ruby
field_test_experiments
```