Updated Utilities (markdown)

[etc/awesome.git] / Widgets.md

diff --git a/Widgets.md b/Widgets.md
index 7c1349e067e08d68dc76f079cc1230d42975a285..981e4e16966fd71596a6a4a1934f0c9fd2f4f0b1 100644 (file)
--- a/Widgets.md
+++ b/Widgets.md
@@ -1,19 +1,35 @@
-[<- home](https://github.com/copycat-killer/lain/wiki)
+Every widget is output by a `function`.
 
+For some widgets, `function` returns a `wibox.widget.textbox`, for others a table to be used for notification and update purposes.
 
-Every widget is output by a `function`.
+Every widget may take either a table or a list of variables as argument.
+
+If it takes a table, you have to define a function variable called `settings` in it, in order to make your customizations.
+
+To markup the textbox, call `widget:set_markup(...)` within `settings`.
+
+You can feed `set_markup` with predefined arguments, see the sections for all the details.
+
+`widget` is a textbox, so you can threat it like any other `wibox.widget.textbox`.
+
+Here follows an example: 
 
-Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
+    mycpu = lain.widgets.cpu({
+        timeout = 4,
+        settings = function()
+            widget:set_markup("Cpu " .. cpu_now.usage)
+        end
+    })
 
-We say this because, for some widget, `function` return a table to be used for notification and update purposes.
+If you want to see more complex applications, check [awesome-copycats](https://github.com/copycat-killer/awesome-copycats).
 
--------
+---
 
 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)
 - [bat](https://github.com/copycat-killer/lain/wiki/bat)
 - [borderbox](https://github.com/copycat-killer/lain/wiki/borderbox)
-- [calendar](https://github.com/copycat-killer/lain/wiki/caldendar)
+- [calendar](https://github.com/copycat-killer/lain/wiki/calendar)
 - [cpu](https://github.com/copycat-killer/lain/wiki/cpu)
 - [fs](https://github.com/copycat-killer/lain/wiki/fs)
 - [imap](https://github.com/copycat-killer/lain/wiki/imap)
@@ -22,4 +38,5 @@ We say this because, for some widget, `function` return a table to be used for n
 - [mpd](https://github.com/copycat-killer/lain/wiki/mpd)
 - [net](https://github.com/copycat-killer/lain/wiki/net)
 - [sysload](https://github.com/copycat-killer/lain/wiki/sysload)
-- [temp](https://github.com/copycat-killer/lain/wiki/temp)
\ No newline at end of file
+- [temp](https://github.com/copycat-killer/lain/wiki/temp)
+- [yawn](https://github.com/copycat-killer/lain/wiki/yawn)
\ No newline at end of file