Skip to content

Commit d87febe

Browse files
committed
docs: update README
1 parent 76b592c commit d87febe

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# BashCompletor
22

3-
A declarative generator for creating bash completion script.
3+
Creating a bash completion script in a declarative way.
44

55
[English](./README.md) | [中文](./README.zh.md)
66

@@ -25,7 +25,7 @@ A declarative generator for creating bash completion script.
2525

2626
## Versioning
2727

28-
Read [tags][] for verions.
28+
Read [tags][] for versions.
2929
The versions follow the rules of [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
3030

3131
## Installation
@@ -88,12 +88,14 @@ Enter `bash-completor` for help.
8888
- [./completor.bash](./completor.bash) It's a simple example. Run `make build` to build the completion script of bash-completor.
8989
- [zig.completor.bash](https://github.com/adoyle-h/shell-completions/blob/feat/bash/zig.completor.bash)
9090
- [nvim-shell-completions/nvim.completor.bash](https://github.com/adoyle-h/nvim-shell-completions/blob/master/nvim.completor.bash)
91+
- Other examples in [./example/](./example/)
9192

9293
### [Syntax](./docs/syntax.md)
9394

9495
## The completion script
9596

96-
The generated completion script follows below code style. It's easy to debug at runtime.
97+
The generated completion script follows below code style. No worry about naming conflict.
98+
And it's easy to debug at runtime.
9799

98100
- The main command completion function must be `_${cmd}_completions`
99101
- All subcmd completion functions must be named with prefix `_${cmd}_completions_${subcmd}`.

README.zh.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# BashCompletor
22

3-
声明式 Bash 补全脚本生成器
3+
声明式编写 Bash 补全脚本
44

55
[English](./README.md) | [中文](./README.zh.md)
66

@@ -26,8 +26,8 @@
2626

2727
## Versioning
2828

29-
Read [tags][] for verions.
30-
The versions follow the rules of [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
29+
版本详见 [tags][]
30+
版本命名遵守 [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html)
3131

3232
## 安装
3333

@@ -89,12 +89,13 @@ sudo ln -s "$PWD/dist/bash-completor" /usr/local/bin/bash-completor
8989
- [./completor.bash](./completor.bash) 一个很简单的例子。运行 `make build` 构建 bash-completor 自身的补全脚本。
9090
- [zig.completor.bash](https://github.com/adoyle-h/shell-completions/blob/feat/bash/zig.completor.bash)
9191
- [nvim-shell-completions/nvim.completor.bash](https://github.com/adoyle-h/nvim-shell-completions/blob/master/nvim.completor.bash)
92+
- 其他例子见 [./example/](./example/)
9293

9394
### [语法](./docs/syntax.md)
9495

9596
## 补全脚本
9697

97-
生成的补全脚本遵循以下代码风格。便于在运行时调试
98+
生成的补全脚本遵循以下代码风格。无需担心重名问题。而且这也便于在运行时调试
9899

99100
- 主命令的补全函数必须是 `_${cmd}_completions`
100101
- 所有子命令的补全函数必须以 `_${cmd}_completions_${subcmd}` 为前缀命名。

0 commit comments

Comments
 (0)