Add example for flags.

ronelliott · Dec 28, 2023 · 051e459 · 051e459
1 parent f6b68e4
commit 051e459
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -99,6 +99,20 @@ Flags can be added to a generated command by calling the `WithFlags` function wi
 | WithStringVar | Add a `string` flag with only a long name. |
 | WithStringVarP | Add a `string` flag with a long and short name. |
 
+### Example
+
+```go
+greeting := "hello!"
+quantity := 1
+cmd, err := snek.NewCommand(
+	snek.WithFlag(
+		snek.WithStringVarP(&greeting, "greeting", "g", greeting, "The greeting to use"),
+		snek.WithStringVarP(&quantity, "quantity", "q", quantity, "The quantity of times to greet"),
+	),
+	// ...
+)
+```
+
 ## Complete Example
 
 ```go