logos-messaging/nim-chat-poc
1
0
Fork 0
mirror of https://github.com/logos-messaging/nim-chat-poc.git synced 2026-01-04 07:03:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update readme

Browse Source
This commit is contained in:
Jazz Turner-Baggs 2025-09-26 19:09:19 -07:00 committed by GitHub
parent 35274b6ec4
commit 1dca74724a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -9,17 +9,20 @@ This POC introduces the following Conversation Types:
Messages are delivered over Waku 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 ## Quick Start
``` ```
# Build Dependencies and link libraries # Build Dependencies and link libraries
nimble initialize make update
# Run the default binary # Build executables
nimble run make all
# Run the Text Interface
./build/tui
``` ```
## Details ## Details
@ -66,8 +69,6 @@ sequenceDiagram
``` ```
## Limitations ## 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. 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.