aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorflu0r1ne <flu0r1ne@flu0r1ne.net>2023-05-04 20:35:20 -0500
committerflu0r1ne <flu0r1ne@flu0r1ne.net>2023-05-04 20:35:45 -0500
commitbbf10c3c00a5356451227e48780d1d5fd4458c5b (patch)
treef68041ed8e823989d21b42606bee8bb9bdf8c695
parentb8bc493d2a682ccea755855fdec5b01ad3eb85f9 (diff)
downloadgpt-chat-cli-bbf10c3c00a5356451227e48780d1d5fd4458c5b.tar.xz
gpt-chat-cli-bbf10c3c00a5356451227e48780d1d5fd4458c5b.zip
Add install instructions
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 72d7986..b5c60f6 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,17 @@ gpt-chat-cli
A simple ChatGPT CLI.
+### Installation:
+
+```
+pip install gpt-chat-cli
+```
+
+The OpenAI API uses API keys for authentication. Visit your (API Keys page)[https://platform.openai.com/account/api-keys] to retrieve the API key you'll use in your requests. Then, source the `OPENAI_API_KEY` environmental variable in your shell's configuration file. (That is, `~/.bashrc` or `~/.zshrc` for the Bash or Zsh shell, respectively.)
+```
+export OPENAI_API_KEY="INSERT_SECRET_KEY"
+```
+
### Examples:
```