Accordion.hs: add module header and usage instructions.

darcs-hash:20070618193626-ea16c-fc5e73006d563e36348f4eda854b8e9f0e2d3ce5.gz

1 files changed, 22 insertions, 1 deletions

diff --git a/Accordion.hs b/Accordion.hs
index c4214f1..82a1853 100644
--- a/Accordion.hs
+++ b/Accordion.hs
@@ -1,4 +1,21 @@
-module XMonadContrib.Accordion (accordion) where
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.Accordion
+-- Copyright   :  (c) glasser@mit.edu
+-- License     :  BSD
+--
+-- Maintainer  :  glasser@mit.edu
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- Layout that puts non-focused windows in ribbons at the top and bottom
+-- of the screen.
+-----------------------------------------------------------------------------
+
+module XMonadContrib.Accordion (
+    -- * Usage
+    -- $ usage
+    accordion) where
 
 import XMonad
 import Operations
@@ -6,6 +23,10 @@ import qualified StackSet as W
 import Graphics.X11.Xlib
 import Data.Ratio
 
+-- $ usage
+-- > import XMonadContrib.Accordion
+-- > defaultLayouts = [ accordion ]
+
 accordion :: Layout
 accordion = Layout { doLayout = accordionLayout
                     , modifyLayout = const $ return Nothing }