summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMartin Bielik <mx.bielik@gmail.com>2023-03-05 11:48:57 +0100
committerMartin Bielik <mx.bielik@gmail.com>2023-03-05 11:48:57 +0100
commit39f34803c68c258a1766ee85161a0407401c284c (patch)
treed0eec30663feb4077cb2d1639a8f3cb4de095bd3 /README.md
parent1cc7f4d97aaa50189a830feecdfae62a49e8b3ec (diff)
downloadvim-ai-39f34803c68c258a1766ee85161a0407401c284c.tar.gz
docu update
Diffstat (limited to '')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 35ce3c0..65a55df 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,17 @@
# vim-ai
-Complete text in vim using OpenAI.
+Complete text and chat with GPT in vim using OpenAI.
+
+## Features
+
+- Generate text or code, answer questions
+- Edit selected text in-place
+- Interactive conversation with ChatGPT
![vim-ai demo](./demo.gif)
## Installation
-Prerequisites:
-
```sh
# configure openai api key https://platform.openai.com/account/api-keys
echo "YOUR_OPENAPI_TOKEN" > ~/.config/openai.token
@@ -22,7 +26,7 @@ Add plugin to your `.vimrc` using `vim-plug`:
Plug 'madox2/vim-ai', { 'do': './install.sh' }
```
-The plugin requires `python3` and `pip3` to be installed.
+The plugin requires `python3` and `pip3` to install and run [openai-python](https://github.com/openai/openai-python) library.
## Usage