Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent b4f14e6 commit c4f88fa4418999f0dbb4e31d20ba84deea09fdcd @garetht committed Jan 25, 2014
Showing with 17 additions and 1 deletion.
  1. +17 −1 README.md
View
@@ -1,4 +1,20 @@
csscomb-brunch
==============
-
Gives Brunch workflows the ability to sort CSS properties.
+
+Installing
+===
+**csscomb-brunch** is designed to be an npm package for use with the build tool Brunch. To install this as a dependency for your Brunch repository, run `npm install --save csscomb-brunch`, which will add a line to your `package.json` file.
+
+Usage
+===
+To specify an encoding you can use the configuration options.
+
+```coffeescript
+exports.config =
+ plugins:
+ csscomb:
+ encoding: 'zen'
+```
+
+By default, the encoding is set to Zen. The string you pass into that field is used to initialize the CSSComb object (`var comb = new Comb('zen');`, see https://npmjs.org/package/csscomb), so any value acceptable there will be acceptable as an argument for `encoding.`

0 comments on commit c4f88fa

Please sign in to comment.