Magnifier.hs: add usage instructions.

darcs-hash:20070618212215-ea16c-1339b2797edeb6141f91bb0b2d4f84cc0e95c600.gz

1 files changed, 8 insertions, 1 deletions

diff --git a/Magnifier.hs b/Magnifier.hs
index 3f378ff..8334844 100644
--- a/Magnifier.hs
+++ b/Magnifier.hs
@@ -17,12 +17,19 @@
 -----------------------------------------------------------------------------
 
 
-module XMonadContrib.Magnifier (magnifier) where
+module XMonadContrib.Magnifier (
+    -- * Usage
+    -- $usage
+    magnifier) where
 
 import Graphics.X11.Xlib
 import XMonad
 import StackSet
 
+-- $usage
+-- > import XMonadContrib.Magnifier
+-- > defaultLayouts = [ magnifier tiled , magnifier $ mirror tiled ]
+
 magnifier :: Layout -> Layout
 magnifier l = l { doLayout = \r s -> applyMagnifier r s `fmap` doLayout l r s
                 , modifyLayout = \x -> fmap magnifier `fmap` modifyLayout l x }