summaryrefslogtreecommitdiff
path: root/experiments
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2020-09-03 11:11:51 -0400
committerGitHub <noreply@github.com>2020-09-03 11:11:51 -0400
commitd298c5c7fba7b73094eee1149b65319994221922 (patch)
treec696b5a3bba6449b36eff6d01a449567585821f6 /experiments
parent55a13022894f5aadb495f6eb255d3df81d5a1440 (diff)
Update README.md
Diffstat (limited to 'experiments')
-rw-r--r--experiments/logout-widget/README.md24
1 files 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