From 7219b0fac6cfebd7f3f9f5c4d25b3e8c319196db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Mon, 17 Nov 2025 12:43:57 +0100 Subject: [PATCH] Add README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..31e1a7f --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# libnymea-networkmanager + +libnymea-networkmanager is the Qt/C++ helper library that lets nymea-based +systems talk to the Linux NetworkManager service over DBus. It provides +wrappers for wired and wireless devices, exposes network states and settings, +and can optionally spin up a Bluetooth Low Energy provisioning server so +headless appliances can be configured remotely. + +## Features + +- High-level API for tracking NetworkManager state, devices, and connections. +- Helpers for managing wired and Wi-Fi profiles, IP configuration, and DHCP. +- Optional BLE server that exposes provisioning services for remote setup. +- Designed to integrate with nymea daemons and other Qt applications. + +## Documentation + +The `docs/` folder contains the QDoc setup used to generate the API reference. +To build it locally run `qdoc docs/config.qdocconf` inside the repository root. + +## License + +libnymea-networkmanager is licensed under the GNU LGPL-3.0-or-later. +See `LICENSE.LGPL3` for the full text. The copyright is held by +nymea GmbH (2013‑2024) and chargebyte austria GmbH (2024‑2025).