Skip to content

Commit 74bc861

Browse files
authored
Update README.md
1 parent 5a5a5b4 commit 74bc861

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ We provide a tools gallery for basic usage, which also serves as examples for fu
9090
| Code editing with LSP information | [Config](https://github.com/you-n-g/simplegpt.nvim/blob/b14c715fda43a0b34cc18ba4394e3440c883f3d5/lua/simplegpt/conf.lua#L157) | [Demo](#code-editing-with-lsp-information) |
9191
| Code editing with terminal context | [Config](https://github.com/you-n-g/simplegpt.nvim/blob/b14c715fda43a0b34cc18ba4394e3440c883f3d5/lua/simplegpt/conf.lua#L211) | [Demo](#code-editing-with-terminal-context) |
9292

93+
Chat
94+
- Start a buffer and chat: [Demo](#chat-in-a-buffer)
95+
- Build Chat based on Rich Context: [Demo](#build-chat-based-on-rich-context)
9396

9497
More tools are coming soon.
9598

@@ -198,6 +201,21 @@ The question is constructed by rendering a template. The 't' register serves as
198201
- Special variables such as `{{content}}`, `{{filetype}}`, and `{{visual}}`.
199202
- Standard registers like `{{a}}`, `{{b}}`, and `{{c}}`.
200203

204+
## Chat
205+
206+
### Chat In A Buffer
207+
[![image](https://github.com/user-attachments/assets/9ada0d88-66e0-4236-a69b-665160e4bcb9)](https://i.redd.it/jqfhzckd2d2f1.gif)
208+
209+
- Press `<localleader>gc` to send current buffer as question to chat or continue chat.
210+
- Press `<localleader>gc` to stop the chat stream.
211+
212+
### Build Chat based on Rich Context
213+
[![image](https://github.com/user-attachments/assets/737d4cbe-9ab0-4e9d-892f-5d7a57887592)](https://i.redd.it/vvvz21cv3d2f1.gif)
214+
215+
216+
- Call any tools (e.g. `<localleader>se`) to build according question based on context.
217+
- Press `Q` to convert the question into a new chat.
218+
- Press `<localleader>gc` to continue chat.
201219

202220
# Features
203221

0 commit comments

Comments
 (0)