]> git.madduck.net Git - etc/awesome.git/blobdiff - yawn.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Updated Utilities (markdown)
[etc/awesome.git] / yawn.md
diff --git a/yawn.md b/yawn.md
index fa6e91ca2c14832c1bdd101bf3fefd19c8fcf16f..6a087cc9fe72cdaa00ad37cb322865f6d9ccdc7e 100644 (file)
--- a/yawn.md
+++ b/yawn.md
@@ -1,7 +1,6 @@
-Yahoo's Awesome Weather notification
------------
+(YAhoo! Weather Notification)
 
-Yawn provides brief and compact weather notification via Naughty and Yahoo! Weather API.
+Yawn provides brief and compact Yahoo! Weather notification.
 
 Usage
 -----
@@ -25,15 +24,18 @@ an existent widget.
 
 - ``args``
 
-    An optional table which can contain the following settings:
+    A required table which can contain:
 
     Variables | Meaning | Type | Possible values | Default value
     --- | --- | --- | --- | ---
     `u` | Units | string | "c" (Celsius), "f" (Fahrenheit) | "c"
-    `toshow` | What to show | string | "forecast", "units", "both" | "forecast"
-    `color` | ``yawn.widget`` color | string | hexadecimal colors | 
+    `timeout` | Refresh timeout seconds | int | integers | 600
+    `settings` | User settings | function | function | empty function
 
-The function creates an imagebox icon and a textbox widget. Add them to you wibox like this:
+    `settings` can use strings `forecast`, `units', and can modify `notification_preset` table, which
+     will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain.
+
+The function `register` creates an imagebox icon and a textbox widget. Add them to you wibox like this:
 
     right_layout:add(yawn.icon)
     right_layout:add(yawn.widget)
@@ -48,7 +50,7 @@ Arguments:
 
 - ``widget``
  
-    The widget which you want to attach yawn to.
+    The widget which you want to attach Yawn to.
 
 - ``id``
 
@@ -63,7 +65,7 @@ Hovering over ``widget`` will display the notification.
 Popup shortcut
 --------------
 
-You can also create a keybinding for the weather popup like this: ::
+You can also create a keybinding for the weather popup like this:
 
     awful.key( { "Mod1" }, "w", function () yawn.show(5) end )
 
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.