From c64687ad08ba0dff16422990d6dfe2934feaa0a8 Mon Sep 17 00:00:00 2001
From: Jasper Van der Jeugt <m@jaspervdj.be>
Date: Mon, 28 May 2012 17:53:38 +0200
Subject: Update README, cabal file

---
 README.markdown | 50 +++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 47 insertions(+), 3 deletions(-)

(limited to 'README.markdown')

diff --git a/README.markdown b/README.markdown
index ead788d..9a02035 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,21 +1,28 @@
 stylish-haskell
 ===============
 
-[![Build Status](https://secure.travis-ci.org/jaspervdj/stylish-haskell-imports.png?branch=master)](http://travis-ci.org/jaspervdj/stylish-haskell-imports)
+[![Build Status](https://secure.travis-ci.org/jaspervdj/stylish-haskell.png?branch=master)](http://travis-ci.org/jaspervdj/stylish-haskell)
 
 Introduction
 ------------
 
-A simple Haskell code prettifier
+A simple Haskell code prettifier. The goal is not to format all of the code in
+a file, since I find those kind of tools often "get in the way".
+
+Instead, this tool just tries to help where necessary.
 
 Features
 --------
 
 - Aligns and sorts `import` statements
-- Groups and wraps `{-# LANGUAGE #-}` pragmas (WIP)
+- Groups and wraps `{-# LANGUAGE #-}` pragmas
 - Removes trailing whitespace
 - Replaces tabs by four spaces
 
+Feature requests are welcome! Use the [issue tracker] for that.
+
+[issue tracker]: https://github.com/jaspervdj/stylish-haskell/issues
+
 VIM integration
 ---------------
 
@@ -25,3 +32,40 @@ Just call
     :%!stylish-haskell
 
 or add a keybinding for it.
+
+Example
+-------
+
+Turns:
+
+    -- | Some badly formatted Haskell code
+    
+    {-# LANGUAGE ViewPatterns, TemplateHaskell #-}
+    {-# LANGUAGE GeneralizedNewtypeDeriving,
+            ViewPatterns,
+            ScopedTypeVariables #-}
+    
+    module Bad where
+    
+    import Control.Applicative ((<$>))
+    import System.Directory (doesFileExist)
+    
+    import qualified Data.Map as M
+    import      Data.Map    ((!), keys, Map)   
+
+into:
+
+    -- | Some badly formatted Haskell code
+    
+    {-# LANGUAGE GeneralizedNewtypeDeriving #-}
+    {-# LANGUAGE ScopedTypeVariables        #-}
+    {-# LANGUAGE TemplateHaskell            #-}
+    {-# LANGUAGE ViewPatterns               #-}
+    
+    module Bad where
+    
+    import           Control.Applicative ((<$>))
+    import           System.Directory    (doesFileExist)
+    
+    import           Data.Map            (Map, keys, (!))
+    import qualified Data.Map            as M
-- 
cgit v1.2.3