Update readme according to go doc
This commit is contained in:
parent
dd939deef3
commit
345db24139
30
README.md
30
README.md
|
@ -62,20 +62,18 @@ Supported shells:
|
|||
Add bash completion capabilities to any Go program. See [./example/command](./example/command).
|
||||
|
||||
```go
|
||||
import (
|
||||
import (
|
||||
"flag"
|
||||
"github.com/posener/complete/v2"
|
||||
"github.com/posener/complete/v2/predict"
|
||||
)
|
||||
|
||||
var (
|
||||
)
|
||||
var (
|
||||
// Add variables to the program.
|
||||
name = flag.String("name", "", "")
|
||||
something = flag.String("something", "", "")
|
||||
nothing = flag.String("nothing", "", "")
|
||||
)
|
||||
|
||||
func main() {
|
||||
)
|
||||
func main() {
|
||||
// Create the complete command.
|
||||
// Here we define completion values for each flag.
|
||||
cmd := &complete.Command{
|
||||
|
@ -90,7 +88,7 @@ func main() {
|
|||
// Parse the flags.
|
||||
flag.Parse()
|
||||
// Program logic...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This package also enables to complete flags defined by the standard library `flag` package.
|
||||
|
@ -99,16 +97,15 @@ To use this feature, simply call `complete.CommandLine` before `flag.Parse`. (Se
|
|||
```diff
|
||||
import (
|
||||
"flag"
|
||||
+ "github.com/posener/complete/v2"
|
||||
+ "github.com/posener/complete/v2"
|
||||
)
|
||||
var (
|
||||
// Define flags here...
|
||||
foo = flag.Bool("foo", false, "")
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Call command line completion before parsing the flags - provide it with the binary name.
|
||||
+ complete.CommandLine("my-program")
|
||||
+ complete.CommandLine("my-program")
|
||||
flag.Parse()
|
||||
}
|
||||
```
|
||||
|
@ -121,18 +118,17 @@ flag with values, it is possible to use the `github.com/posener/complete/compfla
|
|||
```diff
|
||||
import (
|
||||
"flag"
|
||||
+ "github.com/posener/complete/v2"
|
||||
+ "github.com/posener/complete/v2/compflag"
|
||||
+ "github.com/posener/complete/v2"
|
||||
+ "github.com/posener/complete/v2/compflag"
|
||||
)
|
||||
var (
|
||||
// Define flags here...
|
||||
- foo = flag.Bool("foo", false, "")
|
||||
+ foo = compflag.Bool("foo", false, "")
|
||||
- foo = flag.Bool("foo", false, "")
|
||||
+ foo = compflag.Bool("foo", false, "")
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Call command line completion before parsing the flags.
|
||||
+ complete.CommandLine("my-program")
|
||||
+ complete.CommandLine("my-program")
|
||||
flag.Parse()
|
||||
}
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue