Skip to content

Commit fecd351

Browse files
committed
updated readme
1 parent d43cac5 commit fecd351

File tree

1 file changed

+6
-34
lines changed

1 file changed

+6
-34
lines changed

README.md

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
[![GoReportCard](https://goreportcard.com/badge/github.com/carapace-sh/carapace)](https://goreportcard.com/report/github.com/carapace-sh/carapace)
66
[![Coverage Status](https://coveralls.io/repos/github/carapace-sh/carapace/badge.svg?branch=master)](https://coveralls.io/github/carapace-sh/carapace?branch=master)
77

8-
Command argument completion generator for [cobra]. You can read more about it here: _[A pragmatic approach to shell completion](https://dev.to/rsteube/a-pragmatic-approach-to-shell-completion-4gp0)_.
9-
8+
Command argument completion generator for [cobra].
109

1110
Supported shells:
1211
- [Bash](https://www.gnu.org/software/bash/)
@@ -20,39 +19,12 @@ Supported shells:
2019
- [Xonsh](https://xon.sh/)
2120
- [Zsh](https://www.zsh.org/)
2221

23-
## Usage
24-
25-
Calling `carapace.Gen` on the root command is sufficient to enable completion using the [hidden command](https://carapace-sh.github.io/carapace/carapace/gen/hiddenSubcommand.html).
26-
27-
```go
28-
import (
29-
"github.com/carapace-sh/carapace"
30-
)
31-
32-
carapace.Gen(rootCmd)
33-
```
34-
35-
## Example
36-
37-
An example implementation can be found in the [example](./example/) folder.
38-
39-
40-
## Standalone Mode
41-
42-
Carapace can also be used to provide completion for arbitrary commands.
43-
See [carapace-bin](https://github.com/carapace-sh/carapace-bin) for examples.
22+
## Getting Started
4423

45-
## Related Projects
24+
[Read], [Try] and [Build].
4625

47-
- [carapace-bin](https://github.com/carapace-sh/carapace-bin) multi-shell multi-command argument completer
48-
- [carapace-bridge](https://github.com/carapace-sh/carapace-bridge) completion bridge
49-
- [carapace-pflag](https://github.com/carapace-sh/carapace-pflag) Drop-in replacement for spf13/pflag with support for non-posix variants
50-
- [carapace-shlex](https://github.com/carapace-sh/carapace-shlex) simple shell lexer
51-
- [carapace-spec](https://github.com/carapace-sh/carapace-spec) define simple completions using a spec file
52-
- [carapace-spec-clap](https://github.com/carapace-sh/carapace-spec-clap) spec generation for clap-rs/clap
53-
- [carapace-spec-kingpin](https://github.com/carapace-sh/carapace-spec-kingpin) spec generation for alecthomas/kingpin
54-
- [carapace-spec-kong](https://github.com/carapace-sh/carapace-spec-kong) spec generation for alecthomas/kong
55-
- [carapace-spec-man](https://github.com/carapace-sh/carapace-spec-man) spec generation for manpages
56-
- [carapace-spec-urfavecli](https://github.com/carapace-sh/carapace-spec-urfavecli) spec generation for urfave/cli
26+
[Read]:https://pixi.carapace.sh
27+
[Try]:./example/
28+
[Build]:https://carapace-sh.github.io/carapace/carapace/gen.html
5729

5830
[cobra]:https://github.com/spf13/cobra

0 commit comments

Comments
 (0)