README: Add mqtt dependency instructions to README

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 <[email protected]>
linux-automation · Apr 29, 2024 · 3e263af · 3e263af
1 parent 0428f47
commit 3e263af
Showing 1 changed file with 13 additions and 2 deletions.
diff --git 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 <contrib/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 <contrib/usbsdmux.config>`_
+for available configuration options.
 
 
 Troubleshooting