doc

cristalhq · Jan 22, 2022 · 4d5e886 · 4d5e886
1 parent 1ed3507
commit 4d5e886
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -62,7 +62,7 @@ r := acmd.RunnerOf(cmds, acmd.Config{
 })
 
 if err := r.Run(); err != nil {
-	panic(err)
+	r.Exit(err)
 }
 ```
 

diff --git a/acmd.go b/acmd.go
@@ -99,7 +99,10 @@ func RunnerOf(cmds []Command, cfg Config) *Runner {
 	return r
 }
 
-// Exit the application.
+// Exit the application depending on the error.
+// If err is nil, so successful/no error exit is done: os.Exit(0)
+// If err is of type ErrCode: code from the error is returned: os.Exit(code)
+// Otherwise: os.Exit(1).
 func (r *Runner) Exit(err error) {
 	if err == nil {
 		os.Exit(0)