From e04c3aaa08e210ac80c52da4631b83df8523a942 Mon Sep 17 00:00:00 2001
From: madeofstown <33820964+madeofstown@users.noreply.github.com>
Date: Sun, 16 Feb 2025 13:21:06 -0800
Subject: [PATCH 1/2] Update and rename README to README.md

Also add new info for correctly cloning to include submodules
---
 README    | 30 ------------------------------
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+), 30 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 1273ae6..0000000
--- a/README
+++ /dev/null
@@ -1,30 +0,0 @@
-Meshview
-========
-
-Now running at https://meshview.bayme.sh
-
-This project watches a MQTT topic for meshtastic messages, imports them to a
-database and has a web UI to view them.
-Requires Python 3.12
-
-Running
--------
-$ python3 -m venv env
-$ ./env/bin/pip install -r requirements.txt
-$ ./env/bin/python main.py
-
-You also need to install:
-    sudo apt-get install graphviz (may be added to requirements.txt?)
-
-Now you can hit http://localhost/
-
-Other Options:
---port
-    Web server port, default is 80
-
---mqtt-server
-    MQTT Server, default is mqtt.bayme.sh
-
---topic
-    MQTT Topic, default is 'msh/US/bayarea/#'
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..33ff392
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+Meshview
+========
+
+Now running at https://meshview.bayme.sh
+
+This project watches a MQTT topic for meshtastic messages, imports them to a
+database and has a web UI to view them.
+Requires Python 3.12
+
+Running
+-------
+Clone the repo from github with:
+``` bash 
+git clone --recurse-submodules https://github.com/pablorevilla-meshtastic/meshview.git
+```
+It is important to include the `--recurse-submodule` flag or the meshtastic protobufs wont be included
+
+Create a python virtual environment:
+``` bash
+cd meshview
+python3 -m venv env
+```
+Install the environment requirements:
+``` bash
+./env/bin/pip install -r requirements.txt
+```
+You also need to install `graphviz`:
+``` bash
+sudo apt-get install graphviz
+```
+
+To run Meshview:
+``` bash
+./env/bin/python main.py
+```
+Now you can hit http://localhost/
+
+Other Options:
+* `--port`
+
+   Web server port, default is `8081`
+
+* `--mqtt-server`
+
+  MQTT Server, default is `mqtt.bayme.sh`
+
+* `--topic`
+    
+  MQTT Topic, default is `msh/US/bayarea/#`
+

From 44f31c5eb70b6ff06237f05632b784df807856c8 Mon Sep 17 00:00:00 2001
From: madeofstown <33820964+madeofstown@users.noreply.github.com>
Date: Sun, 16 Feb 2025 13:28:11 -0800
Subject: [PATCH 2/2] Update README.md

fixed a spelling error
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 33ff392..bfb8c9b 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ Clone the repo from github with:
 ``` bash 
 git clone --recurse-submodules https://github.com/pablorevilla-meshtastic/meshview.git
 ```
-It is important to include the `--recurse-submodule` flag or the meshtastic protobufs wont be included
+It is important to include the `--recurse-submodules` flag or the meshtastic protobufs wont be included
 
 Create a python virtual environment:
 ``` bash