Update README.md

nowrep · Jul 12, 2022 · 6804d1a · 6804d1a
1 parent 6b9bfee
commit 6804d1a
Showing 1 changed file with 23 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# wljoywake
-Wayland idle inhibit on joystick input
+# Wayland Joystick Wake
+
+Wayland tool for idle inhibit when using joysticks. Requires idle_inhibit_unstable_v1 protocol.
+
+    Usage: wljoywake [options]
+
+    Options:
+      -t TIMEOUT_SECONDS    Set idle wakeup timeout
+      -h --help             Show this help message
+      -v --version          Show version
+
+
+### Dependencies
+
+* wayland-client
+* wayland-scanner
+* wayland-protocols
+* libudev
+
+### Building
+
+    meson setup --prefix /usr build
+    ninja -C build && ninja -C build install