From 9f70d3cc3d55cc601700f5d14049ba9bde7628f8 Mon Sep 17 00:00:00 2001
From: hirokisan <dev@hirokiueno.com>
Date: Sat, 11 Mar 2023 22:02:56 +0900
Subject: [PATCH] docs: add README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..426893c
--- /dev/null
+++ 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?
+```