From 39f34803c68c258a1766ee85161a0407401c284c Mon Sep 17 00:00:00 2001 From: Martin Bielik Date: Sun, 5 Mar 2023 11:48:57 +0100 Subject: docu update --- README.md | 12 ++++++++---- 1 file 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 -- cgit v1.2.3