Skip to content

Commit

Permalink
Add send and receive subcommands to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
brannondorsey committed Oct 7, 2018
1 parent c8037ec commit 549efa7
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ node build/main.js chat
# open the chat room
chattervox chat

# send a packet from the command-line
chattervox send "this is a chattervox packet sent from the command-line."

# receive *all* packets and print them to stdout
chattervox receive --allow-all

# generate a new public/private key pair, and use it as your default signing key
chattervox genkey --make-signing

Expand All @@ -81,19 +87,20 @@ chattervox showkey

```
usage: chattervox [-h] [-v] [--config CONFIG]
{chat,showkey,addkey,removekey,genkey} ...
{chat,send,receive,showkey,addkey,removekey,genkey} ...
An AX.25 ham radio chat protocol with support for digital signatures
and binary compression.
An AX.25 packet radio chat protocol with support for digital signatures and
binary compression. Like IRC over radio waves 📡〰.
Optional arguments:
-h, --help Show this help message and exit.
-v, --version Show program's version number and exit.
--config CONFIG, -c CONFIG
Path to config file (default: ~/.chattervox/config.json)
Path to config file (default: /home/braxxox/.
chattervox/config.json)
subcommands:
{chat,showkey,addkey,removekey,genkey}
{chat,send,receive,showkey,addkey,removekey,genkey}
```

## The Protocol
Expand Down

0 comments on commit 549efa7

Please sign in to comment.