aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0496c1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+copenai is a simple CURSES interface to an OpenAI compatible API. The
+command is simply:
+
+copenai base_url
+
+Where base_url is the base URL of the API. The secret API key is read
+from the environment variable OPENAI_APIKEY. This is done to prevent
+passing it on the command line and leaking it via process listings.