summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Smrž <roman.smrz@seznam.cz>2024-07-16 21:43:53 +0200
committerRoman Smrž <roman.smrz@seznam.cz>2024-07-16 21:48:05 +0200
commit215e441511c88bfb40eec58aa1f0f7c540bf506b (patch)
tree9407abe6c3c2707c010be78ec2065be0241c360c
parent710e6121a755959dbf423aa828bd3cc7af4214a2 (diff)
Chatroom usage example
-rw-r--r--README.md21
1 files changed, 18 insertions, 3 deletions
diff --git a/README.md b/README.md
index e69332d..ac262d9 100644
--- a/README.md
+++ b/README.md
@@ -60,7 +60,8 @@ Add public peer:
[1] PEER UPD discovery1.erebosprotocol.net [37.221.243.57 29665]
```
-Select the peer and send it a message, the public server just responds with automatic echo message:
+Select the peer and send it a message, the public server just responds with
+automatic echo message:
```
> /1
discovery1.erebosprotocol.net> hello
@@ -68,6 +69,20 @@ discovery1.erebosprotocol.net> hello
[18:55] discovery1.erebosprotocol.net: Echo: hello
```
+List chatrooms known to the peers:
+```
+> /chatrooms
+[1] Test chatroom
+[2] Second test chatroom
+```
+
+Enter a chatroom and send a message there:
+```
+> /1
+Test chatroom> Hi
+Test chatroom [19:03] Some Name: Hi
+```
+
### Messaging
`/peers`
@@ -99,10 +114,10 @@ Currently only public unmoderated chatrooms are supported, which means that any
network peer is allowed to read and post to the chatroom. Individual messages
are signed, so message author can not be forged.
-`/chatrooms`
+`/chatrooms`
: List known chatrooms.
-`/chatroom-create-public [<name>]`
+`/chatroom-create-public [<name>]`
: Create public unmoderated chatroom. Room name can be passed as command
argument or entered interactively.