1 files changed, 42 insertions, 0 deletions

diff --git a/sqlchat/README.md b/sqlchat/README.md
new file mode 100644
index 00000000..89d38fae
--- /dev/null
+++ b/sqlchat/README.md
@@ -0,0 +1,42 @@
+### Example: `sqlchat` (use like openai pypi package) <a name="example-sqlchat"></a>
+
+```python
+# Import sqlchat
+import sqlchat
+
+# sqlchat.Completion.create
+# sqlchat.StreamCompletion.create
+
+[...]
+
+```
+
+#### Example Chatbot
+```python
+messages = []
+
+while True:
+    user = input('you: ')
+
+    sqlchat_cmpl = sqlchat.Completion.create(
+        prompt   = user,
+        messages = messages
+    )
+
+    print('gpt:', sqlchat_cmpl.completion.choices[0].text)
+    
+    messages.extend([
+        {'role': 'user', 'content': user }, 
+        {'role': 'assistant', 'content': sqlchat_cmpl.completion.choices[0].text}
+    ])
+```
+
+#### Streaming Response:
+
+```python
+for response in sqlchat.StreamCompletion.create(
+    prompt   = 'write python code to reverse a string',
+    messages = []):
+
+    print(response.completion.choices[0].text)
+```