Skip to content

Commit a1c5e7f

Browse files
author
skywind3000
committed
update doc
1 parent 8e3f40a commit a1c5e7f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Generate proper git commit message using ChatGPT in Vim:
66

77
This plugin provides a `:GptCommit` command to generate commit message and append in the current buffer.
88

9+
Usually, it can be used when editing the `COMMIT_EDITMSG` file, or in a fugitive commit window.
10+
911
## Quick start
1012

1113
For vim-plug:
@@ -40,12 +42,12 @@ Requirements:
4042
This plugin provides only one command:
4143

4244
```VimL
43-
:GptCommand[!] [repo_path]
45+
:GptCommit[!] [repo_path]
4446
```
4547

4648
It will generate git commit message and append to the current cursor position. If the `repo_path` is omitted, the directory name of the current buffer will be used.
4749

48-
If the bang (`!`) is included, `:GptCommand` will not append any text to the current buffer, instead, it will only store the messages in the unnamed register (`*`). You can use them any time manually by `"*p` or display the content by:
50+
If the bang (`!`) is included, `:GptCommit` will not append any text to the current buffer, instead, it will only store the messages in the unnamed register (`*`). You can use them any time manually by `"*p` or display the content by:
4951

5052
```VimL
5153
:echo @*
@@ -95,7 +97,7 @@ If you find this plugin amusing, you might also be interested in my other vim pl
9597
- [vim-auto-popmenu](https://github.com/skywind3000/vim-auto-popmenu): Display the completion menu automantically.
9698
- [vim-color-export](https://github.com/skywind3000/vim-color-export): A tool to backport NeoVim colorschemes to Vim.
9799
- [vim-navigator](https://github.com/skywind3000/vim-navigator): Navigate your commands easily.
98-
- [vim-rt-format](https://github.com/skywind3000/vim-rt-format): Prettify current line on Enter.
100+
- [vim-rt-format](https://github.com/skywind3000/vim-rt-format): Prettify current line when you press Enter.
99101
- [vim-quickui](https://github.com/skywind3000/vim-quickui): The missing UI extensions for Vim 8.2 (and NeoVim 0.4).
100102
- [asynctasks.vim](https://github.com/skywind3000/asynctasks.vim): Modern task system for project building/testing/deploying.
101103

0 commit comments

Comments
 (0)