Merge pull request akamensky#61 from PeterlitsZo/master

akamensky · web-flow · commit f2e138ca01a4 · 2020-04-22T09:29:25.000+08:00
add useful part in README part
diff --git a/README.md b/README.md
@@ -137,6 +137,33 @@ You can implement sub-commands in your CLI using `parser.NewCommand()` or go eve
 Since parser inherits from command, every command supports exactly same options as parser itself,
 thus allowing to add arguments specific to that command or more global arguments added on parser itself!
 
+#### Basic Option Structure
+
+The `Option` structure is declared at `argparse.go`:
+```go
+type Options struct {
+	Required bool
+	Validate func(args []string) error
+	Help     string
+	Default  interface{}
+}
+```
+
+You can Set `Required` to let it know if it should ask for arguments.
+Or you can set `Validate` as a lambda function to make it know while value is valid.
+Or you can set `Help` for your beautiful help document.
+Or you can set `Default` will set the default value if user does not provide a value.
+
+Example:
+```
+dirpath := parser.String("d", "dirpath",
+			 &argparse.Options{
+			 	Require: false,
+				Help: "the input files' folder path",
+				Default: "input",
+			})
+```
+
 #### Caveats
 
 There are a few caveats (or more like design choices) to know about:
