From: Luke Bonham <dadasignificanulla@gmail.com>
Date: Sat, 7 Sep 2013 10:28:21 +0000 (-0700)
Subject: Created cpu (markdown)
X-Git-Url: https://git.madduck.net/etc/awesome.git/commitdiff_plain/d866043cd7ef8b9861573fba00f9e95b186f261d?ds=inline

Created cpu (markdown)
---

diff --git a/cpu.md b/cpu.md
new file mode 100644
index 0000000..bdcc128
--- /dev/null
+++ b/cpu.md
@@ -0,0 +1,15 @@
+Shows the average CPU usage percent for a given amount of time.
+
+	mycpuusage = lain.widgets.cpu()
+
+The function takes a table as optional argument, which can contain:
+
+Variable | Meaning | Type | Default
+--- | --- | --- | ---
+`refresh_timeout` | Refresh timeout seconds | int | 10
+`header` | Text to show before value | string | " Vol "
+`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
+`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
+`footer` | Text to add after value | string | "%"
+
+**Note**: `footer` color is `color`.
\ No newline at end of file