quickstart

sloganking · Oct 22, 2023 · 6c440a5 · 6c440a5
1 parent a09c61c
commit 6c440a5
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,18 @@
 # desk-talk
 
+Transcription for your desktop.
+
+## Quickstart
+
+Assign your OpenAI API key to the `OPENAI_API_KEY` environment variable and run:
+
+```
+desk-talk --ptt-key scroll-lock
+```
+
+Or pass your OpenAI API key as a flag like so:
+
+```
+desk-talk --ptt-key scroll-lock --api-key [YOUR_API_KEY]
+```
+