Updated net (markdown)

[etc/awesome.git] / Utilities.md

diff --git a/Utilities.md b/Utilities.md
index 4fc80e4ddee6b4926e163108c5632d7d609353c4..6afff16c8771ae2d239fb22846d2f14574e780ff 100644 (file)
--- a/Utilities.md
+++ b/Utilities.md
@@ -1,13 +1,11 @@
-[<- home](https://github.com/copycat-killer/lain/wiki)
-
 markup
 ------
 
-This is a submodule which helps you markupping your text.
+Made markup easier!
 
-First, call it like this:
+First, require it like this:
 
-    local markup = require("lain.util.markup")
+    local markup = lain.util.markup
 
 then you can call its functions:
 
@@ -40,13 +38,19 @@ then you can call its functions:
      |`-- normal()      Set both foreground and background normal colors.
       `-- urgent()      Set both foreground and background urgent colors.
 
+they all take one argument, which is the text to markup, except `fg.color` and `bg.color`:
+
+    markup.fg.color(text, color)
+    markup.bg.color(text, color)
+
 menu\_clients\_current\_tags
 ----------------------------
 
-Similar to `awful.menu.clients()`, but this menu only shows the clients
+Similar to `awful.menu.clients`, but this menu only shows the clients
 of currently visible tags. Use it with a key binding like this:
 
-    awful.key({ "Mod1" }, "Tab", function()
+    awful.key({ "Mod1" }, "Tab",
+    function()
         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
         awful.menu.menu_keys.up = { "Up", "k" }
         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })