add Readme

2026-02-26 08:23:05 +01:00
parent ddc60f80fb
commit e9bb5074cf
1 changed files with 21 additions and 0 deletions
@@ -0,0 +1,21 @@
+# EZGG LAN NFC Tools
+
+This repository contains the tooling around NFC readers/writers.
+
+Currently supported NFC Device: ACR 1252U
+
+## Tools:
+
+- card_reader
+  - Standalone: Reads single card and prints content
+  - Library: API for extracting user ID from card
+- card_writer
+  - Standalone: Takes user ID as console input, writes it securely to card
+- ClipboardReaderService
+  - Standalone: Continuously reads cards and writes decrypted user ID or error message to clipboard
+
+## Intended usage
+
+Start `ClipboardReaderService` on terminals where LAN team needs to verify guest identity, EZGG LAN manager then reads user ID from clipboard.
+
+Run `card_writer` when preparing tickets.