From d14b04cc0c8bd8e1305e333e418aa0b9346c05a6 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Mon, 29 Apr 2024 04:35:58 +1200 Subject: [PATCH] add readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e854105 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Reticulum WebChat + +A simple web based [LXMF](https://github.com/markqvist/lxmf) client for [Reticulum](https://github.com/markqvist/Reticulum). + +## Features + +- Supports sending to and receiving messages from [Sideband](https://github.com/markqvist/Sideband/) and [Nomadnet](https://github.com/markqvist/nomadnet). +- Supports receiving images sent from Sideband. +- Supports receiving file attachments sent from Sideband. + +## How does it work? + +- A python script (`web.py`) runs a Reticulum instance and a WebSocket server. +- The web page sends and receives lxmf packets encoded in json via the WebSocket. +- Web Browser -> WebSocket -> Python Reticulum -> (configured interfaces) -> (destination) + +