From 3f739baab456c2cc977f11090381d1f61eb023c4 Mon Sep 17 00:00:00 2001
From: xengineering <mail2xengineering@protonmail.com>
Date: Thu, 15 Oct 2020 12:48:30 +0200
Subject: Split Executable to reduce root-priviledged Code Execution

---
 README.md | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c1f49b8..96b137f 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,33 @@
 A service that makes barcode scanners available on the network for IoT use.
 
 
+## Usage
+
+1. Adapt config.json file if needed.
+2. Run ```sudo python barcode_scanner_daemon.py```
+3. Run ```python barcode_transmit_daemon.py```
+4. Listen to MQTT output (e.g. with ```mosquitto_sub -h localhost -t "xengineering.eu/iot-barcode-scanner"```)
+
+
 ## Milestones
 
-- MVP: Forward keyboard/scanner input to MQTT topic
-- Read MQTT connection details from config file
-- Disable scanner as regular input source and bind it only to the service
-- Package it for Arch Linux
+- [x] MVP: Forward keyboard/scanner input to MQTT topic
+- [x] Use config file
+- [x] Disable scanner as regular input source and bind it only to the service
+- [x] Split into two executables to reduce root-priviledged code
+- [ ] Implement systemd services
+- [ ] Write Makefile for easy installation
+- [ ] Implement auto discovery of barcode scanners
+- [ ] Package it for Arch Linux
+
+
+## Dependencies
+
+- ```python-paho-mqtt```
+- ```python-evdev```
+
+
+## Links
+
+- [python-evdev documentation](https://python-evdev.readthedocs.io/en/latest/index.html)
+- [Please answer this guy!](https://stackoverflow.com/questions/49850238/redirect-usb-hid-barcode-output-to-dev-tty-device)
-- 
cgit v1.2.3-70-g09d2