airship/airshipctl
Code Issues Proposed changes

Update readme

Browse Source
This commit is contained in:
Ian Howell 2019-06-06 16:26:38 -05:00
parent 56a4824524
commit 6aa4d897fd
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -34,7 +34,7 @@ import (
)
func main() {
rootCmd, err := cmd.NewRootCmd(os.Stdout)
rootCmd, _, err := cmd.NewRootCmd(os.Stdout)
if err != nil {
fmt.Fprintf(os.Stderr, "Failed to create root airshipctl command: %s\n", err.Error())
os.Exit(1)
@ -64,4 +64,12 @@ Now that you've built `airshipctl`, you can access your plugin with the followin
./airshipctl example
```
For a more involved example, see the [example plugin project](github.com/ian-howell/examplepugin)
You may have noticed that this example ignores the second return value from
cmd.NewRootCmd. This value is a pointer to the AirshipCTLSettings, which
contains various configuration details, such as the debug flag and the path to
the config file\*. A useful paradigm involves embedding this object into a
custom ExampleSettings struct. This can be seen in the demo repo.
For a more involved example, see the [demo repo](github.com/ian-howell/examplepugin)
\* Work in progress