From 5d5da7eed7c0cd1e0f534c2a5f2da215caa4356a Mon Sep 17 00:00:00 2001
From: Kai Jan Kriegel <kai@kjkriegel.de>
Date: Sun, 13 Mar 2022 19:17:07 +0100
Subject: [PATCH] Added usage instructions

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a7e2462
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+FabFire Adapter
+===
+The FabFire adapter translates mqtt messages from the reader hardware to api calls to bffhd.
+
+# Usage
+## Configuration in `config.toml`
+1. Set `hostname` and `port` for your MQTT Broker and bffhd instance
+2. Add your readers to the `[readers]` section. Every reader needs a unique subsection name:
+```toml
+[readers]
+    [readers.REPLACEME]
+    id = "111"
+    machine = "urn:fabaccess:resource:Testmachine"
+
+    [readers.REPLACEMETOO]
+    id = "222"
+    machine = "urn:fabaccess:resource:Another"
+```
+
+## Running
+1. Install the requirements with `pip install -r requirements.txt`
+2. Run the adapter with at least python 3.7
+```shell
+python3 main.py
+```
+3. The adapter has to remain running for the readers to work
+
+# Provisioning
+
+See the [provisioning tool](https://gitlab.com/fabinfra/fabaccess/FabFire-Provisioning-Tool) repo.
\ No newline at end of file