From 965e711975f396e5bc50abc0fa422e0fd35bbb28 Mon Sep 17 00:00:00 2001
From: Carlos Alfredo Diaz <cdiazjr4@gmail.com>
Date: Tue, 26 Jul 2022 21:33:24 -0400
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index b11f91c..5d9833b 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,38 @@ https://github.com/joshpirihi/meshtastic-mqtt
 
 
 ![Full page](https://user-images.githubusercontent.com/6488786/181139834-7cf71745-b981-492f-9545-8916f83b5ef7.png)
+
+
+The script requires:
+
+python and pip to be installed on the server 
+for linux (apt):
+```
+sudo apt install python3 ipmitool python3-pip
+```
+as well as the following modules with pip:
+
+yaml, paho-mqtt and python-daemon (which are all on ports):
+```
+sudo pip install yaml paho-mqtt pySimpleGUI protobuf
+```
+
+Once installed, just copy this repo (you can use git clone), complete the YAML file and rename it config.yaml in the /config/ folder, make the script executable and run it.There's an example config file (config - example.yaml), you can directly modify and rename it config.yaml.
+It must contain:
+
+An MQTT configuration with IP, user, password, otherwise it will run until:
+```
+MQTT:
+    MQTT_ip: MQTT BROKER IP
+    MQTT_USER: 'MQTT user'
+    MQTT_PW: 'MQTTPASSWORD'
+```
+Your Meshtastic configuration, basically channel id, client id and gateway id:
+
+```
+MESHTASTIC:
+    CHANNEL_ID: 'ShortFast' # the name of your channel
+    CLIENT_ID: '12345678' #the id for your program to use
+    GATEWAY_ID: '!12345678' # Your gateway's id
+```
+And you're set.