Release v3 (#31)

* Release v3

* Update readme

Author: jelmersnoeck

README.md

@@ -22,6 +22,12 @@ current package you're using. Tests help you transition from one package to
 the other, but you want to see how this behaves under load.
 
 ```go
+package main
+
+import (
+	"github.com/jelmersnoeck/experiment/v3"
+)
+
 func main() {
 	exp := experiment.New[string](
 		experiment.WithPercentage(50),
@@ -50,6 +56,10 @@ about your new implementation.
 
 ## Usage
 
+### Import
+
+This package uses go modules. To import it, use `github.com/jelmersnoeck/experiment/v3` as import path.
+
 ### Control
 
 `Control(func(context.Context) (any, error))` should be used to implement your
@@ -61,7 +71,7 @@ panic.
 
 ```go
 func main() {
-	exp := experiment.New(
+	exp := experiment.New[string](
 		experiment.WithPercentage(50),
 	)
 
@@ -236,7 +246,7 @@ Observation values through a provided logger or the standard library logger.
 
 ```go
 func main() {
-	exp := experiment.New(
+	exp := experiment.New[string](
 		experiment.WithPercentage(50),
 	).WithPublisher(experiment.NewLogPublisher[string]("publisher", nil))
 

_examples/http_handler.go

@@ -8,7 +8,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/jelmersnoeck/experiment"
+	"github.com/jelmersnoeck/experiment/v3"
 )
 
 type handleFunc func(http.ResponseWriter, *http.Request)
@@ -50,6 +50,15 @@ func exampleHandler() handleFunc {
 			return "", errors.New("bar")
 		})
 
+		exp.Candidate("timeout", func(ctx context.Context) (string, error) {
+			select {
+			case <-time.Tick(time.Second):
+				return "Waited a full second!", nil
+			case <-ctx.Done():
+				return "Timeout hit", ctx.Err()
+			}
+		})
+
 		exp.Compare(func(control, candidate string) bool {
 			fmt.Printf("Comparing '%s' with '%s'\n", control, candidate)
 			return control == candidate

experiment_test.go

@@ -8,7 +8,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/jelmersnoeck/experiment"
+	"github.com/jelmersnoeck/experiment/v3"
 )
 
 func TestRun(t *testing.T) {

go.mod

@@ -1,3 +1,3 @@
-module github.com/jelmersnoeck/experiment
+module github.com/jelmersnoeck/experiment/v3
 
 go 1.19

publisher_test.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/jelmersnoeck/experiment"
+	"github.com/jelmersnoeck/experiment/v3"
 )
 
 func ExampleLogPublisher() {