From d298c5c7fba7b73094eee1149b65319994221922 Mon Sep 17 00:00:00 2001 From: streetturtle Date: Thu, 3 Sep 2020 11:11:51 -0400 Subject: Update README.md --- experiments/logout-widget/README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/experiments/logout-widget/README.md b/experiments/logout-widget/README.md index 96dde68..f1b1e4e 100644 --- a/experiments/logout-widget/README.md +++ b/experiments/logout-widget/README.md @@ -41,17 +41,15 @@ Clone repo (if not cloned yet) under ~/.config/awesome, then # Customisation -## Phrase +| Name | Default | Description | +|---|---|---| +| `bg_color` | beautiful.bg_normal | The color the background of the | +| `accent_color` | beautiful.bg_focus | The color of the buttons | +| `text_color` | beautiful.fg_normal | The color of text | +| `phrases` | {'Goodbye!'} | The table with phrase(s) to show, if more than one provided, the phrase is chosen randomly | +| `onlogout` | function () awesome.quit() end | Function which is called when the logout button is pressed | +| `onlock` | | Function which is called when the lock button is pressed | +| `onreboot` | | Function which is called when the reboot button is pressed | +| `onsuspend` | function () awful.spawn.with_shell("systemctl suspend") end | Function which is called when the suspend button is pressed | +| `onpoweroff` | function () awful.spawn.with_shell("shutdown now") end | Function which is called when the poweroff button is pressed | - - - bg_color = args.bg_color or beautiful.bg_normal - accent_color = args.accent_color or beautiful.bg_focus - text_color = args.text_color or beautiful.fg_normal - phrases = args.phrases or {'Goodbye!'} - - onlogout = args.onlogout or function () awesome.quit() end - onlock = args.onlock - onreboot = args.onreboot - onsuspend = args.onsuspend or function () awful.spawn.with_shell("systemctl suspend") end - onpoweroff = args.onpoweroff or function () awful.spawn.with_shell("shutdown now") end \ No newline at end of file -- cgit v1.2.3