Merge branch 'master' of ssh:/jjviana/witty into master

Makefile

@@ -10,6 +10,12 @@ cross-compile:
  GOOS=darwin GOARCH=amd64 go build -o build/witty-darwin-amd64/witty ./cmd/witty
  GOOS=freebsd GOARCH=amd64 go build -o build/witty-freebsd-amd64/witty ./cmd/witty
 
+# zip binaries
+.PHONY :zip
+zip:
+ @echo "zipping binaries"
+ cd build && zip -r witty-linux-amd64.zip witty-linux-amd64 && zip -r witty-darwin-amd64.zip witty-darwin-amd64 && zip -r witty-freebsd-amd64.zip witty-freebsd-amd64 
+
 # get the current directory
 pwd:=${PWD}
 # run witty on Linux using Docker, inheriting the environment variable OPENAPI_API_KEY

Readme.md

@@ -1,8 +1,20 @@
-# Witty
+# WiTTY
 
 Witty is a smart terminal emulator, powered by [OpenAI Codex](https://openai.com/blog/openai-codex/).
 It will suggest completions for anything run under it (shell, text editors etc.) in a way that is similar to [Github Copilot](https://copilot.github.com/). 
 
+## Running
+
+You will need an OpenAI API key with access to the Codex models.
+
+```
+git clone https:/jjviana/witty.git
+cd witty/cmd/witty
+go build .
+export OPENAPI_API_KEY=<your api key>
+./witty 
+(see --help for options)
+```
 # Demos
 
 In the demos below the autocomplete suggestions are rendered in red. 
@@ -15,6 +27,12 @@ how to handle image conversion:
 
 https://user-images.githubusercontent.com/1808006/143602390-d2ecd65d-7fa0-4952-a630-438467b2b7ca.mov
 
+## Kubernetes
+
+Kubernetes controlled from natural language:
+
+https://user-images.githubusercontent.com/1808006/143656487-5d2028fc-2926-46ad-a261-403e763991c6.mov
+
 
 
 ## System Administration
@@ -33,13 +51,13 @@ https://user-images.githubusercontent.com/1808006/143599435-c8bd4143-d22f-429b-8
 
 ## Data Science
 
-Here Witty manipulates a CSV file and performs data transformations: 
+Here Witty manipulates a CSV file and performs data transformations, while seamlessly switching from bash to Python:
 
 https://user-images.githubusercontent.com/1808006/143598361-e68f450b-6586-4cef-b1e1-0dd89901bf08.mp4
 
 # Credits
 
 This project would not have been possible without:
 - [OpenAI Codex](https://openai.com/blog/openai-codex/), of course.
-- [vt10x](github.com/ActiveState/vt10x), a terminal emulator backend in Go
-- [tcell](github.com/gdamore/tcell), a terminal screen renderer in Go
+- [vt10x](https://github.com/ActiveState/vt10x), a terminal emulator backend in Go
+- [tcell](https://github.com/gdamore/tcell), a terminal screen renderer in Go