Skip to content

Commit

Permalink
docs(README): update
Browse files Browse the repository at this point in the history
  • Loading branch information
abgox committed Dec 15, 2024
1 parent 1e007b3 commit 2f7b1f9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,13 @@
- 当打开 `PowerShell` 并导入 `PSCompletions` 模块后,`PSCompletions` 会开启一个后台作业去检查远程仓库中补全的状态
- 获取到更新后,会在下一次打开 `PowerShell` 并导入 `PSCompletions` 后显示补全更新提示
### 关于选项类补全
- 选项类补全,指的是像 `-*` 的命令补全,例如 `git config --global` 中的 `--global`
- 你应该优先使用选项类补全
- 以 `git` 补全为例,如果你想要输入 `git config user.name --global xxx`
- 你应该先补全 `--global`,然后再补全 `user.name`,最后输入名称 `xxx`
### 关于补全菜单
- 除了 `PowerShell` 内置的补全菜单,`PSCompletions` 模块还提供了一个更强大的补全菜单。
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,12 @@
- When `PSCompletions` module is imported after starting `PowerShell`, it will start a background job to check for the completion status of the remote repository.
- After getting the update, `PSCompletions` will show the latest status of the completions in the next time.
### About option completion
- `Optional Completion`: some command completions that like `-*`, such as `--global` in `git config --global`.
- You should use option completion first.
- Taking `git` as an example, if you want to enter `git config user.name --global xxx`, you should use `--global` completion first, and then use `user.name`, and then enter the name `xxx` .
### About completion menu
- In addition to the built-in completion menu of `PowerShell`, `PSCompletions` module also provides a more powerful completion menu.
Expand Down

0 comments on commit 2f7b1f9

Please sign in to comment.