summaryrefslogtreecommitdiff
path: root/doc/vim-ai.txt
diff options
context:
space:
mode:
authorMartin Bielik <mx.bielik@gmail.com>2023-02-27 21:23:12 +0100
committerMartin Bielik <mx.bielik@gmail.com>2023-02-27 21:26:18 +0100
commit7849ee09c54008cf2b87cd8af7e694367d14c879 (patch)
tree9680f237fda9e169e357d179e66e193b20cdafae /doc/vim-ai.txt
parent5c1104c5dbd81b4574b2b5a6f3f27c0457ed529c (diff)
downloadvim-ai-7849ee09c54008cf2b87cd8af7e694367d14c879.tar.gz
docu
Diffstat (limited to 'doc/vim-ai.txt')
-rw-r--r--doc/vim-ai.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/vim-ai.txt b/doc/vim-ai.txt
new file mode 100644
index 0000000..f4e3545
--- /dev/null
+++ b/doc/vim-ai.txt
@@ -0,0 +1,25 @@
+*vim-ai.txt* Complete text using OpenAI API.
+
+Author: Martin Bielik <https://madox2.poriadne.sk/>
+License: see https://github.com/madox2/vim-ai/blob/main/LICENSE
+
+INTRODUCTION *vim-ai*
+
+This plugin can be used to generate code, edit text, brainstorm ideas,
+translate, etc.
+
+COMMANDS *vim-ai-commands*
+
+To set-up key bindings and expamples see:
+https://github.com/madox2/vim-ai
+
+ *: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.
+
+ABOUT *vim-ai-about*
+
+Contributions are welcome on GitHub:
+
+https://github.com/madox2/vim-ai