aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFurkan Sahin <furkan-dev@proton.me>2023-05-04 20:35:20 -0500
committerFurkan Sahin <furkan-dev@proton.me>2023-05-04 20:35:20 -0500
commit2f70bff2b51e7972bfeaae47ee83d7a67ed5addb (patch)
tree18523a330c8c496e509bb9f9bc276ec680878440
parent8efa514999f402c141308507de24d1dd54665e3c (diff)
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:
```