Update README.md (#9)

Update README with setup docs

README.md

@@ -1,20 +1,27 @@
 # bot-banter
 
+This is a PoC demonstrating how two bots can autonomously "speak" to each other using an [LLM](https://en.wikipedia.org/wiki/Large_language_model) and [TTS](https://simple.wikipedia.org/wiki/Text_to_speech).
+It uses [NATS jetstream](https://docs.nats.io/nats-concepts/jetstream) for message routing, [ollama](https://ollama.com/) for generating text using an LLM of the user's choice and [playht](https://play.ht) API for TTS speech synthesis.
+
 [![Build Status](https://github.com/milosgajdos/bot-banter/workflows/CI/badge.svg)](https://github.com/milosgajdos/bot-banter/actions?query=workflow%3ACI)
 [![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/milosgajdos/bot-banter)
 [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
+> [!IMPORTANT]
+> This project was built purely for educational purposes and thus is likely ridden with bugs, inefficiencies, etc.
+> You should consider this project as highly experimental.
 
 # HOWTO
 
 There are a few prerequisites:
 * [nats](https://nats.io/)
 * [ollama](https://ollama.com/)
-* sound/audio libraries on some platforms
+* Create an account on [playht](https://play.ht/)
+* sound/audio libraries on some platforms e.g. Linux
 
 ## Run NATS
 
-Both bots use [nats](https://nats.io/) as their communcation channel.
+Both bots use [nats](https://nats.io/) as their communication channel.
 
 ### Homebrew
 
@@ -38,7 +45,7 @@ nats-server -js
 
 ## Run Ollama
 
-Download it from the [official site](https://ollama.com/) or see for the Nix install below.
+Download it from the [official site](https://ollama.com/) or see the Nix install below.
 
 ### Nix
 
@@ -50,18 +57,35 @@ Run a model you decide to use
 ```shell
 ollama run llama2
 ```
+
 ## Audio libraries
 
-If you are running on Linux you need to install the following libraries -- assuming you want to play with the bot speaking service
+If you are running on Linux you need to install the following libraries -- assuming you want to play with the bot-speaking service
 
 > [!NOTE]
 > This is for Ubuntu Linux, other distros have likely different package names
 ```shell
 sudo apt install -y --no-install-recommends libasound2-dev pkg-config
 ```
 
+## playht API credentials
+
+Once you've created an account on [playht](https://play.ht) you need to generate API keys.
+See [here](https://docs.play.ht/reference/api-authentication) for more details.
+
+Now, you need to export them via the following environment variables which are read by the client libraries we use ([go-playht](https://github.com/milosgajdos/go-playht), [playht_rs](https://github.com/milosgajdos/playht_rs)):
+```shell
+export PLAYHT_SECRET_KEY=XXXX
+export PLAYHT_USER_ID=XXX
+```
+
 ## Run the bots
 
+> [!IMPORTANT]
+> Once you've started `gobot` you need to prompt it.
+> `gobot` reads prompt from `stdin` which kickstarts the conversation:
+> `rusbot` waits for `gobot` before it responds!
+
 Start the `gobot`:
 ```shell
 go run ./gobot/...
@@ -71,3 +95,5 @@ Start the `rustbot`:
 ```shell
 cargo run --manifest-path rustbot/Cargo.toml
 ```
+
+