docs: add README.md

hirokisan · Mar 11, 2023 · 9f70d3c · 9f70d3c
1 parent 11fd3d7
commit 9f70d3c
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# chatty
+
+chatty is a cli application that will be your conversation partner in your spare time.
+
+## Preparation
+
+Create OpenAI account and get API Key.
+
+ref: https://platform.openai.com/account/api-keys
+
+And then, set the key in the environment variable.
+
+```console
+$ export OPEN_AI_KEY={key}
+```
+
+## Installation
+
+```console
+$ go install github.com/hirokisan/chatty@latest
+```
+
+## Usage
+
+```console
+$ chatty my name is chatty
+Hello, Chatty! How can I assist you today?
+```