diff --git a/README.md b/README.md index 38fa66a..2ea1e5d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ ## MMRELAYNODE -### A relay between Meshtastic and Matrix with native Meshtastic node connected via MQTT +### A dockerized relay between Meshtastic and Matrix with native Meshtastic node connected via MQTT and the meshtastic node is virtualized too. The repository uses firmware built based on [https://github.com/meshtastic/firmware](https://github.com/meshtastic/firmware). @@ -7,6 +7,8 @@ Relay operation is implemented using the **Meshtastic <=> Matrix Relay** [https: Feel free to explore the **Meshtastic** project on their website: [https://meshtastic.org](https://meshtastic.org). +This project consists of two containers `mmrealynode-app` and `mmrelaynode-device`. + ``` git clone https://github.com/mate-dev/mmrelaynode.git cd mmrelaynode && git submodule update --init @@ -26,4 +28,4 @@ Use the following command to see the output of command_wrapper.py & the MESHTAST docker exec -it mmrelaynode-app cat /home/mesh/app/command_output.txt ``` -Note: If you have several commands, it may take a few minutes to finish them all. \ No newline at end of file +Note: If you have several commands, it may take a few minutes to finish them all.