From 8fbc70c1a5fef2b8dcd034b41dea2fac94d4082c Mon Sep 17 00:00:00 2001
From: shiro <shiro@usagi.io>
Date: Wed, 29 Nov 2023 15:38:04 +0900
Subject: [PATCH] Update Reader API

---
 docs/src/content/docs/en/api/reader.mdx | 31 +++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/docs/src/content/docs/en/api/reader.mdx b/docs/src/content/docs/en/api/reader.mdx
index 0036352..f1a8069 100644
--- a/docs/src/content/docs/en/api/reader.mdx
+++ b/docs/src/content/docs/en/api/reader.mdx
@@ -10,3 +10,34 @@ import map2
 # readers intercept all keyboard inputs and forward them
 reader = map2.Reader(patterns=["/dev/input/by-id/my-keyboard"])
 ```
+
+
+
+All devices matching a pattern will be *grabbed*, meaning all events will be intercepted by map2
+and not forwarded to the system. If events are not passed to an output device such as [Writer](/map2/en/api/writer),
+they will be lost, please avoid locking your only keyboard when testing.
+
+
+## Options
+
+
+### Patterns
+
+- type: string[]
+
+A list of file descriptors to intercept events from.
+
+The patterns are regular expressions, if you are not familiar with them, consider reading a
+[quick tutorial](https://www.regular-expressions.info/quickstart.html).
+
+Some quick examples:
+
+- `/dev/input5`: The specific device on `/dev/input5`
+- `/dev/input\d+`: All input devices
+- `/dev/input/by-id/.*Gaming_Keyboard.*`: All devices who's ID contains `Gaming_Keyboard`
+
+
+
+## Methods
+
+This object has no methods.