Initial commit

1 files changed, 28 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ebae2ca
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+Keyboard Listener(kl)
+=====================
+
+DESCRIPTION
+
+	This is a simple tool to print the key 
+	you pressed in real-time.
+
+USAGE
+
+	kl <EVENT_FILE_PATH>
+
+	The argument <EVENT_FILE_PATH> is the path
+	of the event file which is linked to your
+	keyboard.
+
+	λ /dev/input/by-id/ ls -lhi /dev/input/by-id
+	total 0
+	1467 lrwxrwxrwx 1 root root 9 May 16 09:22 
+	usb-SEMICO_USB_Gaming_Keyboard-event-kbd -> ../event4
+
+	Then run `sudo kl /dev/input/event4`, the key
+	you pressed will be print on STDOUT.
+
+REPORT
+	
+	Feel free to create a PR : )
+