From 73ae832b43d0f5e87401716a6e9ff71866964118 Mon Sep 17 00:00:00 2001
From: liamcottle <liam@liamcottle.com>
Date: Mon, 29 Apr 2024 16:45:06 +1200
Subject: [PATCH] add docs for cli args

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index a138744..476d1e6 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,27 @@ python web.py
 
 > NOTE: You should now be able to access the web interface at http://localhost:8000
 
+For a full list of command line options, you can run;
+
+```
+python web.py --help
+```
+
+```
+usage: web.py [-h] [--host [HOST]] [--port [PORT]] [--identity-file IDENTITY_FILE] [--identity-base64 IDENTITY_BASE64]
+
+ReticulumWebChat
+
+options:
+  -h, --help            show this help message and exit
+  --host [HOST]         The address the web server should listen on.
+  --port [PORT]         The port the web server should listen on.
+  --identity-file IDENTITY_FILE
+                        Path to a Reticulum Identity file to use as your LXMF address.
+  --identity-base64 IDENTITY_BASE64
+                        A base64 encoded Reticulum Identity to use as your LXMF address.
+```
+
 ## Using an existing Reticulum Identity
 
 By default, a random identity is generated every time you run the script.