From: Luke Bonham <copycat-killer@users.noreply.github.com>
Date: Mon, 23 Dec 2013 17:10:31 +0000 (-0800)
Subject: Created brigthness (markdown)
X-Git-Url: https://git.madduck.net/etc/awesome.git/commitdiff_plain/ba7f3b15ec47e9293628e10565f55fca72dca05f

Created brigthness (markdown)
---

diff --git a/brigthness.md b/brigthness.md
new file mode 100644
index 0000000..b0dfe76
--- /dev/null
+++ b/brigthness.md
@@ -0,0 +1,24 @@
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
+Shows the current level of screen brightness.
+
+	mybrightness = lain.widgets.contrib.brightness()
+
+### input table
+
+Variable | Meaning | Type | Default
+--- | --- | --- | ---
+`backlight` | Card managing backlight | `acpi_video0` 
+`timeout` | Refresh timeout seconds | int | 5
+`settings` | User settings | function | empty function
+
+`settings` can use the string `brightness_now`, which indicates the current brightness level.
+
+### output table
+
+Variable | Meaning | Type
+--- | --- | ---
+`widget` | The textbox | `wibox.widget.textbox`
+`update` | The notification | function
+
+You can control the widget with key bindings like these: [TODO]
\ No newline at end of file