From 8219fff08f29a1aa9ab4933d15318cb8919846ac Mon Sep 17 00:00:00 2001 From: Martin Bielik Date: Sat, 4 Mar 2023 18:48:54 +0100 Subject: new commands docu --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 74e0ac1..86696df 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,30 @@ The plugin requires `python3` and `pip3` to be installed. ## Usage -### Basic usage +### :AI -`:AI {prompt}` - completes selected text (visual mode) or text on the current line (normal mode). Passing optional `{prompt}` parameter prepends it to the final prompt. +`:AI` - complete the text on the current line + +`:AI {prompt}` - complete the prompt + +`(visual selection) :AI` - complete the selection + +`(visual selection) :AI {instruction}` - complete the selection using the instruction + +### :AIEdit + +`(visual selection)? :AIEdit` - edit the current line or the selection + +`(visual selection)? :AIEdit {instruction}` - edit the current line or the selection using the instruction + +### :AIChat + + +`:AIChat` - continue or start a new conversation. + +`(visual selection)? :AIChat {instruction}?` - start a new conversation given the selection, the instruction or both + +## Configuration ### Key bindings -- cgit v1.2.3