From a9bef84e8add7306985a7162729358c7aac7fb6e Mon Sep 17 00:00:00 2001 From: Stefan Haun Date: Fri, 8 Apr 2022 18:50:03 +0200 Subject: [PATCH] List features in README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 3187730..970a332 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,14 @@ A daemon that connects to a [PingBoard](https://github.com/PingTechGmbH/PingBoar sends key presses and accepts configuration via [RabbitMQ](https://www.rabbitmq.com/). The main goal is to enable the PingBoard as an IoT input device and execute actions outside the USB host. +Features: +* Emits AMQP messages on Pingboard key press. +* Configures Pingboard (Brightness, Key LED colors, Blinking) with AMQP messages. +* Detects PingBoard via evdev and grabs it to prevent rogue inputs to other applications. +* Reconnects when connections to RabbitMQ or Pingboard are lost. Can also be started without Pingboard present. +* Current state is pushed to the configuration queue when finishing, so that it can be retrieved on the next run. +* Runs out of an unprivileged Docker container. + ## Table of Contents - [Usage](#usage)