summaryrefslogtreecommitdiff
path: root/text-clock-widget
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2020-11-25 09:36:12 -0500
committerGitHub <noreply@github.com>2020-11-25 09:36:12 -0500
commiteda0388f06fb7cad13603bc4c4f5c44b7d1fc62c (patch)
treee6e1d9122538b12e717dda1f3031f50dc9681151 /text-clock-widget
parent5e0030094446cd064fd2ca79dc69e9a6efab4712 (diff)
Update README.md
Diffstat (limited to 'text-clock-widget')
-rw-r--r--text-clock-widget/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/text-clock-widget/README.md b/text-clock-widget/README.md
index 0c07507..c4c6281 100644
--- a/text-clock-widget/README.md
+++ b/text-clock-widget/README.md
@@ -17,6 +17,21 @@ It is possible to customize widget by providing a table with all or some of the
| military_time | `false` | 12 or 24 time format |
| with_spaces | `false` | Separate words with spaces |
+## Installation
+
+Clone repo, include widget and use it in **rc.lua**:
+
+```lua
+local text_clock = require("awesome-wm-widgets.text-clock-widget.text-clock")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ text_clock(),
+ ...
+```
+
# Screenshots
```lua