summaryrefslogtreecommitdiffstats
path: root/minikrebs/profiles/nfc-login/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'minikrebs/profiles/nfc-login/doc/README.md')
-rw-r--r--minikrebs/profiles/nfc-login/doc/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/minikrebs/profiles/nfc-login/doc/README.md b/minikrebs/profiles/nfc-login/doc/README.md
new file mode 100644
index 00000000..f1cdc112
--- /dev/null
+++ b/minikrebs/profiles/nfc-login/doc/README.md
@@ -0,0 +1,10 @@
+# NFCGATE
+
+
+The NFC-Gate is part of the [User Suppository](https://github.com/shackspace/user_suppository) infrastructure. It polls the attached nfc-connector for new cards and uses the UID of the card for trying to either log in or log out the user at the shack-infrastructure.
+
+The nfcgate is a build for the MR3020, not the WR703 as it uses all the
+available LEDs to display the status of the login.
+
+For more information see: [Github Repository](https://github.com/shackspace/user_suppository)
+