initmain

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12095d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# wlr-idle-proxy
+
+A simple org.freedesktop.ScreenSaver implementation for Wayland compositors that support idle-inhibit-unstable-v1.
+This allows software that inhibits screen locking over DBus to transparently inhibit idling on these compositors.
+
+## build
+
+```
+meson build
+ninja -C build
+```
+
+## usage
+
+Just run the output binary in `build`.