Skip to content

Commit 549efa7

Browse files
committed
Add send and receive subcommands to README.
1 parent c8037ec commit 549efa7

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ node build/main.js chat
6666
# open the chat room
6767
chattervox chat
6868

69+
# send a packet from the command-line
70+
chattervox send "this is a chattervox packet sent from the command-line."
71+
72+
# receive *all* packets and print them to stdout
73+
chattervox receive --allow-all
74+
6975
# generate a new public/private key pair, and use it as your default signing key
7076
chattervox genkey --make-signing
7177

@@ -81,19 +87,20 @@ chattervox showkey
8187

8288
```
8389
usage: chattervox [-h] [-v] [--config CONFIG]
84-
{chat,showkey,addkey,removekey,genkey} ...
90+
{chat,send,receive,showkey,addkey,removekey,genkey} ...
8591
86-
An AX.25 ham radio chat protocol with support for digital signatures
87-
and binary compression.
92+
An AX.25 packet radio chat protocol with support for digital signatures and
93+
binary compression. Like IRC over radio waves 📡〰.
8894
8995
Optional arguments:
9096
-h, --help Show this help message and exit.
9197
-v, --version Show program's version number and exit.
9298
--config CONFIG, -c CONFIG
93-
Path to config file (default: ~/.chattervox/config.json)
99+
Path to config file (default: /home/braxxox/.
100+
chattervox/config.json)
94101
95102
subcommands:
96-
{chat,showkey,addkey,removekey,genkey}
103+
{chat,send,receive,showkey,addkey,removekey,genkey}
97104
```
98105

99106
## The Protocol

0 commit comments

Comments
 (0)