X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/e10db094153d2d2cc605aac179a0f18ed7161929..fb09ee4af8c314eed06a01b1aa147f5b6a5a442e:/yawn.md diff --git a/yawn.md b/yawn.md index 070bf2e..30d160c 100644 --- a/yawn.md +++ b/yawn.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + (YAhoo! Weather Notification) Yawn provides brief and compact Yahoo! Weather notification. @@ -24,15 +26,18 @@ an existent widget. - ``args`` - An optional table which can contain the following settings: + A required table which can contain: Variables | Meaning | Type | Possible values | Default value --- | --- | --- | --- | --- `u` | Units | string | "c" (Celsius), "f" (Fahrenheit) | "c" - `toshow` | What to show | string | "forecast", "units", "both" | "forecast" - `color` | ``yawn.widget`` color | string | hexadecimal colors | + `timeout` | Refresh timeout seconds | int | integers | 600 + `settings` | User settings | function | function | empty function + + `settings` can use strings `forecast`, `units`, and can modify `yawn_notification_preset` table, which + will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. -The function creates an imagebox icon and a textbox widget. Add them to you wibox like this: +The function `register` creates an imagebox icon and a textbox widget. Add them to you wibox like this: right_layout:add(yawn.icon) right_layout:add(yawn.widget)