Updated fs (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
 -----
 
 Usage
 -----


@@ -25,15 +24,18 @@ an existent widget.
 
 - ``args``
 
 
 - ``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"
 
     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)
 
     right_layout:add(yawn.icon)
     right_layout:add(yawn.widget)


@@ -48,7 +50,7 @@ Arguments:
 
 - ``widget``
  
 
 - ``widget``
  

-    The widget which you want to attach yawn to.
+    The widget which you want to attach Yawn to.

 
 - ``id``
 
 
 - ``id``
 


@@ -63,7 +65,7 @@ Hovering over ``widget`` will display the notification.
 Popup shortcut
 --------------
 
 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 )
 
 
     awful.key( { "Mod1" }, "w", function () yawn.show(5) end )