Skip to content

Commit c2059ab

Browse files
committed
docs: update README
1 parent d87febe commit c2059ab

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Creating a bash completion script in a declarative way.
77
## Feature
88

99
- Declarative programming. You only need to know the most basic bash syntax.
10-
- Only `bash` and `sed` are needed on at compile time. Only `bash` is needed on at run time. No other dependencies.
10+
- Only `bash` and `sed` are needed on at compile time. Only `bash` is needed on at runtime. No other dependencies.
1111
- Support for command format looks like `<cmd> [options] [arguments]`.
1212
- Support for sub-commands, which looks like `<cmd> [cmd-options] <subcmd> [subcmd-options] [arguments]`.
1313
- Support for `-o`, `--option`, `--option <value>`, `--option=`, `+o`, `+option` format.
@@ -86,7 +86,7 @@ Enter `bash-completor` for help.
8686
### Examples
8787

8888
- [./completor.bash](./completor.bash) It's a simple example. Run `make build` to build the completion script of bash-completor.
89-
- [zig.completor.bash](https://github.com/adoyle-h/shell-completions/blob/feat/bash/zig.completor.bash)
89+
- [zig.completor.bash](https://github.com/ziglang/shell-completions/blob/master/zig.completor.bash)
9090
- [nvim-shell-completions/nvim.completor.bash](https://github.com/adoyle-h/nvim-shell-completions/blob/master/nvim.completor.bash)
9191
- Other examples in [./example/](./example/)
9292

README.zh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ sudo ln -s "$PWD/dist/bash-completor" /usr/local/bin/bash-completor
8787
### 例子
8888

8989
- [./completor.bash](./completor.bash) 一个很简单的例子。运行 `make build` 构建 bash-completor 自身的补全脚本。
90-
- [zig.completor.bash](https://github.com/adoyle-h/shell-completions/blob/feat/bash/zig.completor.bash)
90+
- [zig.completor.bash](https://github.com/ziglang/shell-completions/blob/master/zig.completor.bash)
9191
- [nvim-shell-completions/nvim.completor.bash](https://github.com/adoyle-h/nvim-shell-completions/blob/master/nvim.completor.bash)
9292
- 其他例子见 [./example/](./example/)
9393

docs/syntax.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
## Examples
44

55
- [../completor.bash](../completor.bash)
6-
- [zig.completor.bash](https://github.com/adoyle-h/shell-completions/blob/feat/bash/zig.completor.bash)
6+
- [zig.completor.bash](https://github.com/ziglang/shell-completions/blob/master/zig.completor.bash)
77
- [nvim-shell-completions/nvim.completor.bash](https://github.com/adoyle-h/nvim-shell-completions/blob/master/nvim.completor.bash)
8+
- Other examples in [../example/](../example/)
89

910
## Meta fields
1011

0 commit comments

Comments
 (0)