diff options
author | streetturtle <streetturtle@gmail.com> | 2020-11-25 09:33:35 -0500 |
---|---|---|
committer | streetturtle <streetturtle@gmail.com> | 2020-11-25 09:33:35 -0500 |
commit | 5e0030094446cd064fd2ca79dc69e9a6efab4712 (patch) | |
tree | e1c8af3d1306badefc157273206c57ba49f1464a /text-clock-widget/README.md | |
parent | 6e83c1ff92c0be6e04ba6adcb0a0a9059dc4107f (diff) |
[text-clock] update readme
Diffstat (limited to 'text-clock-widget/README.md')
-rw-r--r-- | text-clock-widget/README.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/text-clock-widget/README.md b/text-clock-widget/README.md new file mode 100644 index 0000000..0c07507 --- /dev/null +++ b/text-clock-widget/README.md @@ -0,0 +1,51 @@ +# Text clock widget + +Widget displaying current time using words: + +![screenshot](./screenshots/halfpastthree.png) + +## Customization + +It is possible to customize widget by providing a table with all or some of the following config parameters: + +| Name | Default | Description | +|---|---|---| +| main_color | `beautiful.fg_normal` | Color of the word on odd position | +| accent_color | `beautiful.fg_urgent` | Color of the word on even position | +| font | `beautiful.font` | Font (`Play 20`) | +| is_human_readable | `false` | _nine fifteen_ or _fifteen past nine_ | +| military_time | `false` | 12 or 24 time format | +| with_spaces | `false` | Separate words with spaces | + +# Screenshots + +```lua + text_clock{ + font = 'Carter One 12', + accent_color = '#ff79c6', + main_color = '#8be9fd', + is_human_readable = true, +} +``` +![](./screenshots/halfpastthree_color.png) + + +```lua +text_clock{ + font = 'Carter One 12', + is_human_readable = true, +} +``` +![](./screenshots/twentythreepastnine.png) + + +```lua +text_clock{ + font = 'Carter One 12', + is_human_readable = true, + military_time = true +} +``` +![](./screenshots/twentythreepasttwentyone.png) + + |