basic readme

README.md

@@ -0,0 +1,26 @@
+# evdev-shortcut
+
+Global shortcuts using evdev
+
+## Usage
+
+```rust
+#[tokio::main]
+async fn main() {
+let listener = ShortcutListener::new();
+listener.add(Shortcut::new(&[Modifier::Meta], Key::KeyN));
+
+    let devices =
+        glob::glob("/dev/input/by-id/*-kbd").unwrap().collect::<Result<Vec<PathBuf>, GlobError>>().unwrap();
+
+    let stream = listener.listen(&devices).unwrap();
+
+    pin_mut!(stream);
+
+    while let Some(shortcut) = stream.next().await {
+        dbg!(shortcut);
+    }
+}
+```
+
+Note that raw access to evdev devices is a privileged operation and usually requires root.