From 8eb9e416cab0d99411b9734be4661ca662f0f615 Mon Sep 17 00:00:00 2001
From: Alberto Lerda <albertolerda97@gmail.com>
Date: Tue, 14 Feb 2023 15:27:58 +0100
Subject: [PATCH] docs: README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b75a61a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+<!--
+SPDX-FileCopyrightText: 2023 Dyne.org foundation
+
+SPDX-License-Identifier: AGPL-3.0-or-later
+-->
+
+# zenflows-fabaccess
+
+Interface between [interfacer-gui](https://github.com/interfacerproject/interfacer-gui) and
+[FabAccess BFFH](https://gitlab.com/fabinfra/fabaccess/bffh) using the 
+[python bindings](https://gitlab.com/fabinfra/fabaccess/pyfabapi) that verify the extistence
+of a DID for the user using [did.dyne.org](explorer.did.dyne.org).
+
+## Configuration
+
+The configuration is done by providing environment variables.
+
+Here is the list of them:
+
+* `FAB_HOST` - hostname MQTT server
+* `FAB_PORT` - port of MQTT server
+* `FAB_USER` - valid username for bffh
+* `FAB_USER` - valid password for bffh
+* `DID_URL` - url for the DID controller
+* `DELTA_TIMESTAMP` - how long is a request valid (in seconds)
+
+## Examples
+
+See the subdirectory `example/`.