X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/095e7e28bfef98509b296ed3e0f0b34c69cf058c..c2c9b33024fc905f900ca861189bb3ef5f7d7468:/maildir.md

diff --git a/maildir.md b/maildir.md
index df5f6fe..355ecdd 100644
--- a/maildir.md
+++ b/maildir.md
@@ -1,4 +1,6 @@
-Checks your maildirs.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
+Shows maildirs status in a textbox.
 
 Maildirs are structured as follows:
 
@@ -17,21 +19,21 @@ Maildirs are structured as follows:
 	.
 
 therefore the widget checks whether there are files in the `new` directories.
-If there's new mail, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says
+If there's new mails, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says
 "no mail".
 
-	mymaildir= lain.widgets.maildir("/path/to/my/maildir")
+	mymaildir = lain.widgets.maildir("/path/to/my/maildir")
 
-The function takes a table as optional argument, which can contain:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 60
 `mailpath` | Path to your maildir | string | "~/Mail"
-`ignore_boxes` | A list of boxes to ignore | table | empty table
-`refresh_timeout` | Refresh timeout seconds | int | 60
-`header` | Text to show before value | string | " Mail "
-`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
-`color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF"
-`app` | Mail program to spawn on click | string | "mutt"| boolean | false
-`shadow` | Hide widget when there are no mails | boolean | false
\ No newline at end of file
+`settings` | User settings | function | empty function
+
+`settings` can use the string `newmail`, which format will be something like defined above, or "no mail".
+
+### output
+
+A textbox.
\ No newline at end of file