summaryrefslogtreecommitdiff
path: root/text-clock-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'text-clock-widget/README.md')
-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