Update documentation and add example

Author: survivorbat

README.md

@@ -1,45 +1,19 @@
 # 🤔 Huh Test
 
-`huhtest` is a work-in-progress test library for your [huh](https://github.com/charmbracelet/huh) forms
+`huhtest` is a work-in-progress test library for your [huh](https://github.com/charmbracelet/huh) forms.
 If you're - for some reason - eager to test your huh-based interactive CLI applications then you've come to
 the right place.
 It works by matching messages in a form's output (stdout) and then sending pre-programmed text to the form's input (stdin).
 
+It's not 100% bug-free, as some combinations of groups and selects seem to have off-by-one errors.
+
 ## ⬇️ Installation
 
 `go get github.com/survivorbat/huhtest`
 
 ## 📋 Usage
 
-```go
-package main
-
-import (
-  "time"
-
-  "github.com/survivorbat/huhtest"
-)
-
-func TestMyForm() {
-  // Arrange
-  myForm := huh.NewForm(/* ... */)
-
-  stdin, stdout, cancel := huhtest.NewResponder().
-    AddResponse("How Are You Feeling?", "Amazing Thanks!").
-    AddConfirm("Would you like a drink?", ConfirmAffirm).
-    AddSelect("Make a second choice", 2).
-    AddMultiSelect("Choose all options that apply", []int{2, 5, 6}),
-    Start(t, 1 * time.Second)
-
-  defer cancel()
-
-  // Act
-  err := myForm.WithInput(formInput).WithOutput(formOutput).Run()
-
-  // Assert
-  // ...
-}
-```
+Check out [this example](./examples_test.go)
 
 ## 🧪 Testing
 
@@ -55,3 +29,4 @@ encounter a bug or are suspicious about something not working, turn it on to see
 ## 🔭 Plans
 
 - Custom keymap support for select fields
+- Select fields should preferably be selected by output text and not index

examples_test.go

@@ -0,0 +1,80 @@
+package huhtest
+
+import (
+	"fmt"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/charmbracelet/huh"
+	"github.com/stretchr/testify/require"
+)
+
+var t = new(testing.T)
+
+func ExampleNewResponder() {
+	// Arrange
+	var (
+		howAreYouFeelingAnswer string
+		areYouReadyAnswer      bool
+		sleptWellAnswer        string
+		activitiesAnswer       []string
+	)
+
+	myForm := huh.NewForm(
+		huh.NewGroup(
+			huh.NewInput().
+				Title("How Are You Feeling?").
+				Value(&howAreYouFeelingAnswer),
+			huh.NewConfirm().
+				Title("Are you ready?").
+				Value(&areYouReadyAnswer),
+			huh.NewSelect[string]().
+				Title("Have you slept well?").
+				Options(
+					huh.NewOption("Well!", "well"),
+					huh.NewOption("Terribly!", "terrible"),
+					huh.NewOption("It was OK!", "ok"),
+				).
+				Value(&sleptWellAnswer),
+		),
+		huh.NewGroup(
+			huh.NewMultiSelect[string]().
+				Title("What are your favourite activities?").
+				Options(
+					huh.NewOption("Cycling", "bike"),
+					huh.NewOption("Sleeping", "sleep"),
+					huh.NewOption("Boating", "boat"),
+					huh.NewOption("Gaming", "game"),
+					huh.NewOption("Flying", "fly"),
+				).
+				Value(&activitiesAnswer),
+		),
+	)
+
+	stdin, stdout, cancel := NewResponder().
+		AddResponse("How Are You Feeling?", "Great").
+		AddConfirm("Are you ready?", ConfirmAffirm).
+		AddMultiSelect("activities", []int{1, 2, 4}).
+		AddSelect("Have you slept well", 2).
+		Start(t, 1*time.Second)
+
+	defer cancel()
+
+	// Act
+	err := myForm.WithInput(stdin).WithOutput(stdout).Run()
+
+	// Assert
+	require.NoError(t, err)
+
+	fmt.Println("How are you feeling?", howAreYouFeelingAnswer)
+	fmt.Println("Are you ready?", areYouReadyAnswer)
+	fmt.Println("Have you slept well?", sleptWellAnswer)
+	fmt.Println("What are your favourite activities?", strings.Join(activitiesAnswer, ", "))
+
+	// Output:
+	// How are you feeling? Great
+	// Are you ready? true
+	// Have you slept well? ok
+	// What are your favourite activities? sleep, boat, fly
+}