From 3b366d5c80c832711bc37a92b204cb30e57986c9 Mon Sep 17 00:00:00 2001
From: Ole Morud <olekr99@hotmail.com>
Date: Sat, 27 May 2023 12:11:35 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..562b815
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+
+# ChatGPT command line interface
+
+ChatGPT in the command line, extended with the ability to run bash commands
+(in a container). Although the host file system is not exposed it can still
+hypothetically fork bomb your computer. Use at your own risk.
+
+## Build
+
+```sh
+go build cmd/ask.go
+```
+
+## Example usage
+
+### Run (Interactive mode)
+
+With gpt-3.5-turbo (default)
+```sh
+$ ./ask
+ChatGPT gpt-3.5-turbo interactive mode
+>
+```
+
+With gpt-4
+```sh
+./ask --model=gpt-4
+```
+
+gpt-4 will usually utilize its command line to solve tasks that it traditionally
+struggles with, such as maths or counting words:
+```sh
+./ask --model=gpt-4
+ChatGPT gpt-4 interactive mode
+> how many words are in the sentence "hello dear world!"?
+# /echo "hello dear world!" | wc -w
+$ 3
+
+# Yes, there are 3 words in the sentence "hello dear world!"
+```
+
+## Run single query
+
+```sh
+ $ ./ask write a python array of 10 nouns
+
+nouns = ["apple", "cat", "book", "car", "tree", "house", "pen", "computer", "phone", "water"]
+```
\ No newline at end of file