Permalink
Browse files

Update README.md

Added Readme
  • Loading branch information...
1 parent 502b56f commit 2b13c3bf7141ca42bbe54e84dac59d25295733e8 @hairyhum committed Aug 22, 2012
Showing with 22 additions and 0 deletions.
  1. +22 −0 README.md
View
22 README.md
@@ -0,0 +1,22 @@
+#Stylish Haskell plugin to Sublime Text 2
+
+## Installation
+Install this repository via [Package Control](http://wbond.net/sublime_packages/package_control)
+
+Install [stylish-haskell](git://github.com/jaspervdj/stylish-haskell.git)
+
+If stylish-haskell executable is not in your PATH - use **add_to_PATH** setting (or same setting in Sublime Haskell package)
+
+## Usage
+To stylish your haskell code run this commands:
+
+- Linux: `ctrl+alt+h`
+- Windows: `ctrl+alt+h`
+- OS X: `super+ctrl+h`
+
+If selection is empty and configuration entry **use_entire_file_if_no_selection** is true, tries to prettify whole file.
+
+## Default configuration
+
+**use_entire_file_if_no_selection** - true
+**add_to_PATH** - empty list

0 comments on commit 2b13c3b

Please sign in to comment.