Skip to content

Commit ea14260

Browse files
committed
Update readme
1 parent 4596676 commit ea14260

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,28 @@
33
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.
44

55

6-
## Message Flow
6+
This POC introduces the following Conversation Types:
7+
- Inbox : Asymmetric channel for receiving invites
8+
- PrivateV1: 1:1 private messaing with Forward Secrecy and Post compromise security
9+
10+
Messages are delivered over Waku
11+
12+
See [nim_chat_poc](./src/nim_chat_poc.nim) for a client side usage example.
13+
14+
15+
## Quick Start
16+
17+
```
18+
# Build Dependencies and link libraries
19+
nimble initialize
20+
21+
# Run the default binary
22+
nimble run
23+
```
24+
25+
## Details
26+
27+
### Message Flow
728

829
To establish a secure conversation, Saro and Raya need to:
930
1. Exchange key material
@@ -44,14 +65,7 @@ sequenceDiagram
4465
C -->> S: Recv M2
4566
```
4667

47-
## Running
48-
49-
5068

51-
```
52-
# Run the default binary
53-
nimble run
54-
```
5569

5670

5771
## Limitations

0 commit comments

Comments
 (0)