diff --git a/README.md b/README.md index d83242b..c397749 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Command line client using the curses library, powered by Meshtastic.org +Python based command line client using the curses library, powered by Meshtastic.org Screenshot_2024-03-29_at_4 00 29_PM @@ -7,3 +7,24 @@ Command line client using the curses library, powered by Meshtastic.org Settings can be accessed within the client or can be run standalone Screenshot 2024-04-15 at 3 39 12 PM + +## Arguments + +You can pass the following arguments to the client: + +### Connection Arguments + +Optional arguments to specify a device to connect to and how. + +- `--port`, `--serial`, `-s`: The port to connect to via serial, e.g. `/dev/ttyUSB0`. +- `--host`, `--tcp`, `-t`: The hostname or IP address to connect to using TCP. +- `--ble`, `-b`: The BLE device MAC address or name to connect to. + +If no connection arguments are specified, the client will attempt a serial connection and then a TCP connection to localhost. + +### Example Usage + +```sh +python main.py --port /dev/ttyUSB0 +python main.py --host 192.168.1.1 +python main.py --ble BlAddressOfDevice \ No newline at end of file