From bcada9527e8754295c45941a32d12e56d8846554 Mon Sep 17 00:00:00 2001
From: Jazz Turner-Baggs <473256+jazzz@users.noreply.github.com>
Date: Sun, 24 Aug 2025 22:28:26 -0700
Subject: [PATCH] Update readme

---
 README.md | 30 ++++++++++++++++++++++--------
 1 file changed, 22 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 94fd6bc..ca424ae 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,28 @@
 This is a technical proof of consuming the [chat_proto](https://github.com/waku-org/chat_proto/tree/base_types?tab=readme-ov-file) in nim.
 
 
-## Message Flow
+This POC introduces the following Conversation Types:
+- Inbox : Asymmetric channel for receiving invites
+- PrivateV1: 1:1 private messaing with Forward Secrecy and Post compromise security
+
+Messages are delivered over Waku
+
+See [nim_chat_poc](./src/nim_chat_poc.nim) for a client side usage example.
+
+
+## Quick Start
+
+```
+# Build Dependencies and link libraries
+nimble initialize
+
+# Run the default binary
+nimble run
+```
+
+## Details
+
+### Message Flow
 
 To establish a secure conversation, Saro and Raya need to:
 1. Exchange key material
@@ -44,16 +65,9 @@ sequenceDiagram
     C -->> S: Recv M2
  ```
 
-## Running
 
 
 
-```
-# Run the default binary
-nimble run
-```
-
-
 ## 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.