From 3e263afdc0ecce9c7e1eff0e175ed78f04db43dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leonard=20G=C3=B6hrs?= Date: Wed, 24 Apr 2024 15:51:14 +0200 Subject: [PATCH] README: Add mqtt dependency instructions to README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The optional dependencies for the mqtt feature can now be installed by a standard pip mechanism, so we should document that in the README. Signed-off-by: Leonard Göhrs --- README.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index f065f12..fe32ca8 100644 --- a/README.rst +++ b/README.rst @@ -217,9 +217,20 @@ MQTT Statistics --------------- This tool can be configured to send certain statistics to a MQTT broker. -To enable this function create a config file at ``/etc/usbsdmux.config`` or use ``--config`` specify a file location. +To use this feature the `usbsdmux` util has to be installed with some +additional dependencies: -See example config file `usbsdmux.config `_. +.. code-block:: bash + + $ python3 -m venv venv + $ source venv/bin/activate + $ python3 -m pip install "usbsdmux[mqtt]" + +To enable this feature create a config file at ``/etc/usbsdmux.config`` +or use ``--config`` to specify a file location. + +See the example config file `usbsdmux.config `_ +for available configuration options. Troubleshooting