From 1dca74724a1cb8c9ee0cd7b4c91e862a2bca3524 Mon Sep 17 00:00:00 2001 From: Jazz Turner-Baggs <473256+jazzz@users.noreply.github.com> Date: Fri, 26 Sep 2025 19:09:19 -0700 Subject: [PATCH] doc: update readme --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ca424ae..1e653eb 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,20 @@ This POC introduces the following Conversation Types: Messages are delivered over Waku -See [nim_chat_poc](./src/nim_chat_poc.nim) for a client side usage example. +See [EchoBot](./examples/bot_echo.nim) for a minimal client side usage example. ## Quick Start ``` # Build Dependencies and link libraries -nimble initialize +make update -# Run the default binary -nimble run +# Build executables +make all + +# Run the Text Interface +./build/tui ``` ## Details @@ -66,8 +69,6 @@ sequenceDiagram ``` - - ## Limitations 1. `.proto` files are included in this repo due to complications in importing nested packages using `?subdir=`. Once resolved there will be a single definition of protocol types.