From c8a4db2e5b1c487971e0dbf27bb49650af9ccd2b Mon Sep 17 00:00:00 2001 From: Myzel394 <50424412+Myzel394@users.noreply.github.com> Date: Sat, 23 Mar 2024 18:52:57 +0100 Subject: [PATCH] feat: Improve README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d159c9a..47ef464 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,31 @@ # zsh-copilot -How we all expected GitHub Copilot in the CLI to be. +Get suggestions **truly** in your shell. No `suggest` bullshit. Just press `CTRL + Z` and get your suggestion. ## Installation +### Dependencies + +Please make sure you have the following dependencies installed: + +* [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) + ```sh git clone https://github.com/Myzel394/zsh-copilot.git ~/.zsh-copilot echo "source ~/.zsh-copilot/zsh-copilot.plugin.zsh" >> ~/.zshrc ``` +### Configuration + +You need to have an OPENAI API key with access to `gpt-4` to use this plugin. Expose this via the `OPENAI_API_KEY` environment variable: + +```sh +export OPENAI_API_KEY= +``` + +I tried out using `gpt-3` but the results were garbage. + ## Usage Type in your command or your message and press `CTRL + Z` to get your suggestion! +