summaryrefslogtreecommitdiff
path: root/experiments/logout-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'experiments/logout-widget/README.md')
-rw-r--r--experiments/logout-widget/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/experiments/logout-widget/README.md b/experiments/logout-widget/README.md
new file mode 100644
index 0000000..f848e5f
--- /dev/null
+++ b/experiments/logout-widget/README.md
@@ -0,0 +1,15 @@
+# Logout widget
+
+# Installation
+
+Clone repo (if not cloned yet) under ~/.config/awesome, then
+
+```lua
+local logout = require("awesome-wm-widgets.experiments.logout-widget.logout")
+
+ -- define a shorcut in globalkey
+ awful.key({ modkey }, "l", function() logout.launch() end, {description = "Show logout screen", group = "custom"}),
+```
+
+# Customisation
+