From ce04667af3ec0f9704e806af400e543863780095 Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Tue, 29 Sep 2020 22:23:02 -0400
Subject: [logout] add shorcuts

---
 logout-widget/README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'logout-widget/README.md')

diff --git a/logout-widget/README.md b/logout-widget/README.md
index a430258..7d1673d 100644
--- a/logout-widget/README.md
+++ b/logout-widget/README.md
@@ -6,6 +6,14 @@ Widget which allows to perform lock, reboot, log out, power off and sleep action
     <img src="https://github.com/streetturtle/awesome-wm-widgets/raw/master/logout-widget/screenshot.gif" alt="screenshot">
 </p>
 
+When the widget is shown, following shortcuts can be used:
+ - <kbd>Escape</kbd> - hide widget
+ - <kbd>s</kbd> - shutdown
+ - <kbd>r</kbd> - reboot
+ - <kbd>u</kbd> - suspend
+ - <kbd>k</kbd> - lock
+ - <kbd>l</kbd> - log out
+
 # Installation
 
 Clone this (if not cloned yet) and the [awesome-buttons](https://github.com/streetturtle/awesome-buttons) repos under **./.config/awesome/**
@@ -50,7 +58,7 @@ Then
 | `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 |
+| `phrases` | `{'Goodbye!'}` | The table with phrase(s) to show, if more than one provided, the phrase is chosen randomly. Leave empty (`{}`) to hide the phrase |
 | `onlogout` | `function() awesome.quit() end` | Function which is called when the logout button is pressed |
 | `onlock` | `function() awful.spawn.with_shell("systemctl suspend") end` | Function which is called when the lock button is pressed |
 | `onreboot` | `function() awful.spawn.with_shell("reboot") end` | Function which is called when the reboot button is pressed |
@@ -62,12 +70,14 @@ Some color themes for inspiration:
 ![nord](./logout-nord.png)
 ![outrun](./logout-outrun.png)
 ![dark](./logout-dark.png)
+![dracula](./logout-dracula.png)
 
 ```lua
 logout.launch{
     bg_color = "#261447", accent_color = "#ff4365", text_color = '#f706cf', icon_size = 40, icon_margin = 16, -- outrun
     -- bg_color = "#0b0c10", accent_color = "#1f2833", text_color = '#66fce1', -- dark
     -- bg_color = "#3B4252", accent_color = "#88C0D0", text_color = '#D8DEE9', -- nord
+    -- bg_color = "#282a36", accent_color = "#ff79c6", phrases = {}, -- dracula, no phrase
     phrases = {"exit(0)", "Don't forget to be awesome.", "Yippee ki yay!"},
 }
 ```
-- 
cgit v1.2.3