From 4b55340c62eb03413214888ee2723339a9db3728 Mon Sep 17 00:00:00 2001
From: gyt4 <158863045+gyt4@users.noreply.github.com>
Date: Sun, 24 Mar 2024 20:00:50 +0800
Subject: [PATCH] Update README.md

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index 4c0aa35..1f62e0c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,36 @@
 # banapass_reader_pn532
 code to use pn532 to make a namco card-if device
+
+# Hardware
+you need :
+
+1. a mcu with dual hardware UART
+2. a pn532 nfc module
+3. (Optional) four ws2812 led
+4. (Optional) a beeper
+
+
+default pin connection can be modified in the code:
+```cpp
+#define sysled 2      //debug led,ignore it
+#define nfccommled 3  //debug led,ignore it
+#define rgbpin 10     //ws2812 DIN pin
+#define beeperpin 6   //beeper pin
+
+#define LEDBrightness 255 
+
+#define Serialto532 Serial0  //uart to pn532
+#define Serialtogame Serial  //uart to game
+```
+
+# Software
+
+install Adafruit_NeoPixel library in your arduino ide.
+
+# Usage
+
+this code can communicate with original namco bngrw.dll  
+make sure no loader hook/emulated it.
+
+for taiko,you can use this TAL:  
+https://github.com/gyt4/tal_no_bngrw_hook