From 7251f663e35191888b87ed4bd3fe3bc4ad286e87 Mon Sep 17 00:00:00 2001
From: Jacek Radzikowski <jacek@piranet.org>
Date: Fri, 28 Jun 2024 16:57:46 -0400
Subject: [PATCH] Added section about CLI arguments to README.md

---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index dd9c3ad..1697064 100644
--- a/README.md
+++ b/README.md
@@ -90,11 +90,41 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
 Run the server with:
 
 ```sh
-python server.py```  
+python server.py
 ```
 
 Be sure you've followed the Python virtual environment steps above and activated it before running.
 
+## Command line arguments
+```
+$ python server.py --help
+
+████████╗ ██████╗██████╗       ██████╗ ██████╗ ███████╗
+╚══██╔══╝██╔════╝╚════██╗      ██╔══██╗██╔══██╗██╔════╝
+   ██║   ██║      █████╔╝█████╗██████╔╝██████╔╝███████╗
+   ██║   ██║     ██╔═══╝ ╚════╝██╔══██╗██╔══██╗╚════██║
+   ██║   ╚██████╗███████╗      ██████╔╝██████╔╝███████║
+   ╚═╝    ╚═════╝╚══════╝      ╚═════╝ ╚═════╝ ╚══════╝
+Meshtastic Version
+
+usage: server.py [-h] [--config CONFIG] [--interface-type {serial,tcp}] [--port PORT] [--host HOST] [--mqtt-topic MQTT_TOPIC]
+
+Meshtastic BBS system
+
+options:
+  -h, --help            show this help message and exit
+  --config CONFIG, -c CONFIG
+                        System configuration file
+  --interface-type {serial,tcp}, -i {serial,tcp}
+                        Node interface type
+  --port PORT, -p PORT  Serial port
+  --host HOST           TCP host address
+  --mqtt-topic MQTT_TOPIC, -t MQTT_TOPIC
+                        MQTT topic to subscribe
+```
+
+
+
 ## Automatically run at boot
 
 If you would like to have the script automatically run at boot, follow the steps below: