Clean up docs

Author: ammario

README.md

@@ -1,14 +1,22 @@
 # cli
 
-A minimal, command-oriented CLI packages.
+A minimal, command-oriented CLI package.
 
 [![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/go.coder.com/cli)
 
 ## Features
 
 - Very small, simple API.
-- Uses stdlib as much as possible.
-- 0 dependencies.
+- Uses standard `flag` package as much as possible.
+- No external dependencies.
+- Subcommands.
+- Auto-generated help.
+
+## Install
+
+```bash
+go get -u go.coder.com/cli
+```
 
 ## Examples
 
@@ -82,7 +90,6 @@ func (c *subcmd) Spec() cli.CommandSpec {
 }
 
 type cmd struct {
-    message string
 }
 
 func (c *cmd) Run(fl *flag.FlagSet) {
@@ -105,8 +112,6 @@ func (c *cmd) Subcommands() []cli.Command {
 }
 
 func main() {
-    cli.RunRoot(&cmd{message: "subcommands"})
+    cli.RunRoot(&cmd{})
 }
-
-
 ```

doc.go

@@ -11,7 +11,4 @@
 //  	cli.FlaggedCommand
 //  	cli.ParentCommand
 //  } = new(rootCmd)
-//
-// This package is exported since we think it could be interesting to the community,
-// but the API is subject to change in support of sail.
 package cli

examples/subcommands/main.go

@@ -23,7 +23,6 @@ func (c *subcmd) Spec() cli.CommandSpec {
 }
 
 type cmd struct {
-	message string
 }
 
 func (c *cmd) Run(fl *flag.FlagSet) {
@@ -46,5 +45,5 @@ func (c *cmd) Subcommands() []cli.Command {
 }
 
 func main() {
-	cli.RunRoot(&cmd{message: "subcommands"})
+	cli.RunRoot(&cmd{})
 }

run.go

@@ -1,57 +1,57 @@
 package cli
 
 import (
-	"flag"
-	"os"
+    "flag"
+    "os"
 )
 
 func appendParent(parent string, add string) string {
-	if parent == "" {
-		return add + " "
-	}
-	return parent + add + " "
+    if parent == "" {
+        return add + " "
+    }
+    return parent + add + " "
 }
 
-// Run executes sets up flags, helps, and executes the command with the provided
+// Run sets up flags, helps, and executes the command with the provided
 // arguments.
 //
 // parents is the list of parent commands.
 // E.g the parent for `sail run hello` would be `sail run`.
 //
 // Use RunRoot if this package is managing the entire CLI.
 func Run(cmd Command, args []string, parent string) {
-	fl := flag.NewFlagSet(parent+""+cmd.Spec().Name, flag.ExitOnError)
-
-	if fc, ok := cmd.(FlaggedCommand); ok {
-		fc.RegisterFlags(fl)
-	}
-
-	fl.Usage = func() {
-		renderHelp(cmd, fl, os.Stderr)
-	}
-	_ = fl.Parse(args)
-
-	subcommandArg := fl.Arg(0)
-
-	// Route to subcommand.
-	if pc, ok := cmd.(ParentCommand); ok && subcommandArg != "" {
-		for _, subcommand := range pc.Subcommands() {
-			if subcommand.Spec().Name != subcommandArg {
-				continue
-			}
-
-			Run(
-				subcommand, fl.Args()[1:],
-				appendParent(parent, cmd.Spec().Name),
-			)
-			return
-		}
-	}
-
-	cmd.Run(fl)
+    fl := flag.NewFlagSet(parent+""+cmd.Spec().Name, flag.ExitOnError)
+
+    if fc, ok := cmd.(FlaggedCommand); ok {
+        fc.RegisterFlags(fl)
+    }
+
+    fl.Usage = func() {
+        renderHelp(cmd, fl, os.Stderr)
+    }
+    _ = fl.Parse(args)
+
+    subcommandArg := fl.Arg(0)
+
+    // Route to subcommand.
+    if pc, ok := cmd.(ParentCommand); ok && subcommandArg != "" {
+        for _, subcommand := range pc.Subcommands() {
+            if subcommand.Spec().Name != subcommandArg {
+                continue
+            }
+
+            Run(
+                subcommand, fl.Args()[1:],
+                appendParent(parent, cmd.Spec().Name),
+            )
+            return
+        }
+    }
+
+    cmd.Run(fl)
 }
 
 // RunRoot calls Run with the process's arguments.
 func RunRoot(cmd Command) {
-	Run(cmd, os.Args[1:], "")
+    Run(cmd, os.Args[1:], "")
 }