From 73bf399cc5b2d2fdd2aa2ea63c4732f91b22ca87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Fri, 14 Nov 2025 16:30:13 +0100 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5aee7e8..9c6243a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,34 @@ # nymea-mqtt + Nymea MQTT broker -The nymea MQTT broker consists of a Qt library containing a MqttClient and a MqttServer implementation. -It can be used standalone or integrated in other applications. +`nymea-mqtt` provides a Qt-based MQTT client and server implementation that can be used standalone or +embedded into other nymea components. Both sides currently support MQTT 3.1.0 and 3.1.1, +communicate over plain TCP or WebSocket transports, and allow SSL/TLS encryption to be enabled or disabled +per deployment. -The currently supported MQTT protocol versions are 3.1.0 and 3.1.1. +Minimal but fully functional examples live in the `server/` and `client/` directories. -Both, the client and the server support raw MQTT over TCP as well as MQTT over web socket. Both transports -can be used with or without SSL encryption. +## Building -Please refer to the server and client directories for minimalistic, yet fully featured examples on how to -use the library. +The project ships qmake files for Qt 5 and Qt 6. Pick one of the `nymea-mqtt.pro` files that matches your +Qt environment and run: + +```bash +qmake +make +``` + +The shared library (`libnymea-mqtt`) can then be linked into your application. The sample client and server +targets are built from the `client/` and `server/` directories in the same way. For packaging, refer to the +Debian metadata in `debian-*`. + +## License + +`libnymea-mqtt` is licensed under the GNU Lesser General Public License version 3 (or, at your option, +any later version). + +The standalone client (`client/`), server (`server/`), and test suite (`tests/`) are GPL-3.0-or-later +programs. + +The full text of the GNU LGPL and GNU GPL is included in `LICENSE.LGPL3` and `LICENSE.GPL3`, respectively.