X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/d6a60f6c89ea5421b21723f12b07888cda3f5530..8f907725c6bc5016c27da6b384a79200167af346:/Widgets.md?ds=sidebyside

diff --git a/Widgets.md b/Widgets.md
index cbf3fb9..1a26b80 100644
--- a/Widgets.md
+++ b/Widgets.md
@@ -1,9 +1,40 @@
-### Foreword
-
 Every widget is output by a `function`.
 
-Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
+For some widgets, `function` returns a `wibox.widget.textbox`, for others 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, 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 also threat it like any other `wibox.widget.textbox`.
+
+Here follows an example: 
+
+    mycpu = lain.widgets.cpu({
+        timeout = 4,
+        settings = function()
+            widget:set_markup("Cpu " .. usage)
+        end
+    })
 
-We say this because, for some widget, `function` return a table to be used for notification and update purposes.
+---
 
-### Index
\ No newline at end of file
+- [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/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)
+- [maildir](https://github.com/copycat-killer/lain/wiki/maildir)
+- [mem](https://github.com/copycat-killer/lain/wiki/mem)
+- [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)
+- [yawn](https://github.com/copycat-killer/lain/wiki/yawn)
\ No newline at end of file