diff --git a/README.md b/README.md new file mode 100644 index 0000000..8294f42 --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file