Add comments to README

muesli · May 1, 2020 · a4eb4f3 · a4eb4f3
1 parent 5791d59
commit a4eb4f3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,8 @@ type User struct {
     Admin bool
 }
 
+// make sure the struct's fields share the name and type
+// of the structs you want to generate
 type UserTests struct {
     Name  []string
     Age   []uint
@@ -38,6 +40,7 @@ testData := UserTests{
     Admin: []bool{false, true},
 }
 
+// generate all possible combinations
 var users []User
 combinator.Generate(&users, testData)
 for i, u := range users {