@@ 0,0 1,29 @@
+# gtklock-dpms-module
+
+This is a loadable module for [GtkLock](https://github.com/jovanlanik/gtklock)
+which will blank (power-off) outputs five seconds after the idle timeout has
+hidden the input password entry. If the idle timeout is disabled, this module
+does nothing.
+
+## Usage
+
+```sh
+gtklock --idle-hide --idle-timeout 10 --modules path/to/libgtklock-dpms.so
+```
+
+## Configuration
+
+There are no configuration options for now.
+
+## Dependencies
+
+* GtkLock 2.1.x
+* GTK+ 3
+
+Additionally, for building:
+
+* Meson
+* Ninja
+* `pkg-config`
+* `wlr-protocols`
+* `wayland-scanner`