Updated Widgets (markdown)

[etc/awesome.git] / Widgets.md

diff --git a/Widgets.md b/Widgets.md
index 6e6d3619931c69ba1080a8a45e9252f3a7dad6e9..a798c678aea10afbdce39c526a9c1f512ce23998 100644 (file)
--- a/Widgets.md
+++ b/Widgets.md
@@ -2,7 +2,20 @@ Every widget is output by a `function`.
 
 Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
 
-We say this because, for some widget, `function` return a table to be used for notification and update purposes.
+This is said because, for some widgets, `function` returns a table to be used for notification and update purposes.
+
+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: with this you can markup textboxes using predefined variables and do whatever customization you want.
+
+Here follows a simple example, see the sections for all the details: 
+
+    mycpu = lain.widgets.cpu({
+        timeout = 4,
+        settings = function()
+            widgets:set_markup("Cpu " .. usage)
+        end
+    })
 
 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)