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.md36
1 files changed, 31 insertions, 5 deletions
diff --git a/experiments/logout-widget/README.md b/experiments/logout-widget/README.md
index f848e5f..d9a3ea9 100644
--- a/experiments/logout-widget/README.md
+++ b/experiments/logout-widget/README.md
@@ -4,12 +4,38 @@
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"}),
-```
+- to show by shortcut:
+
+ ```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"}),
+ ```
+
+- to show by clicking on a widget in wibar:
+
+ ```lua
+ local logout = require("awesome-wm-widgets.experiments.logout-widget.logout")
+
+ s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ logout.widget{
+ bg_color = "#000000",
+ accent_color = "#888888",
+ text_color = '#ffffff',
+ phrases = {'Yippee ki yay!', 'Hasta la vista, baby', 'See you later, alligator!', 'After a while, crocodile.'},
+ onlogout = function() naughty.notify{text = "Logged out!"} end
+ },
+ ...
+ ```
# Customisation
+
+## Phrase
+
+You can provide a phrase which appears on the widget.