Add usage to readme

cmoog · cmoog · commit 6867ab3c61b8 · 2020-07-29T12:49:38.000-05:00
Change-Id: Iced549dd1bf7b601b117b35b0e1fadfd31205d82
diff --git a/README.md b/README.md
@@ -17,3 +17,24 @@ Download the latest [release](https://github.com/cdr/coder-cli/releases):
 cd ~/go/bin
 tar -xvf ~/Downloads/coder-cli-linux-amd64.tar.gz
 ```
+
+## Usage
+
+```
+$ coder --help
+Usage: coder [subcommand] [flags]
+
+coder provides a CLI for working with an existing Coder Enterprise installation.
+
+Commands:
+        envs        get a list of active environment
+        login       authenticate this client for future operations
+        logout      remote local authentication credentials (if any)
+        sh          executes a remote command on the environment
+        sync        establish a one way directory sync to a remote environment
+        urls        get all development urls for external access
+        version     print the currently installed CLI version
+        config-ssh  add your Coder Enterprise environments to ~/.ssh/config
+        users       used to interact with user accounts
+
+```
diff --git a/cmd/coder/version.go b/cmd/coder/version.go
@@ -15,7 +15,7 @@ func (versionCmd) Spec() cli.CommandSpec {
 	return cli.CommandSpec{
 		Name:  "version",
 		Usage: "",
-		Desc:  "Print the currently installed CLI version",
+		Desc:  "print the currently installed CLI version",
 	}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ func (versionCmd) Spec() cli.CommandSpec {`
`15`	`15`	`return cli.CommandSpec{`
`16`	`16`	`Name: "version",`
`17`	`17`	`Usage: "",`
`18`		`- Desc: "Print the currently installed CLI version",`
	`18`	`+ Desc: "print the currently installed CLI version",`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`