docs

Author: jescalan

README.md

@@ -1,4 +1,4 @@
-# spike-css-standards
+# Spike CSS Standards
 
 [![npm](https://img.shields.io/npm/v/spike-css-standards.svg?style=flat-square)](https://npmjs.com/package/spike-css-standards)
 [![tests](https://img.shields.io/travis/static-dev/spike-css-standards.svg?style=flat-square)](https://travis-ci.org/static-dev/spike-css-standards?branch=master)
@@ -9,9 +9,6 @@ standard plugin pack for postcss
 
 > **Note:** This project is in early development, and versioning is a little different. [Read this](http://markup.im/#q4_cRZ1Q) for more details.
 
-### Why should you care?
-
-Write about why this project is important.
 
 ### Installation
 
@@ -21,7 +18,40 @@ Write about why this project is important.
 
 ### Usage
 
-How to use this project.
+This is nothing more than a light wrapper around a postcss configuration object. Options are filtered into their appropriate plugins internally. All are optional.
+
+```js
+const reshape = require('postcss')
+const htmlStandards = require('spike-css-standards')
+
+postcss(cssStandards(/* options */))
+  .process(someCss)
+  .then((res) => { console.log(res.content) })
+```
+
+By default, the css standard plugin pack includes:
+
+- [sugarss](https://github.com/postcss/sugarss), provided as default parser
+- [postcss-import](https://github.com/postcss/postcss-import), default settings
+- [postcss-cssnext](http://cssnext.io/), default settings
+- [rucksack](https://simplaio.github.io/rucksack/), default settings
+- [cssnano](http://cssnano.co/), toggled with the `minify` option which is false by default
+
+Any of these plugins can be customized by passing options described below.
+
+### Options
+
+| Name | Description | Default |
+| ---- | ----------- | ------- |
+| **root** | Root path used to resolve layouts and includes | |
+| **addDependencyTo** | Object with `addDependency` method that will get file paths for tracked deps from includes/layouts | |
+| **webpack** | Shortcut for webpack users to set the `root` and `addDependencyTo` options more easily. Pass webpack loader context. | |
+| **browsers** | Browser support provided to [autoprefixer](http://cssnext.io/usage/#browsers) | `> 1%, last 2 versions, Firefox ESR` |
+| **features** | Enable or disable [cssnext features](http://cssnext.io/usage/#features) | |
+| **warnForDuplicates** | Enable or disable [cssnext duplicate warnings](http://cssnext.io/usage/#warnforduplicates) | `true` |
+| **rucksack** | Options passed directly to [rucksack](http://simplaio.github.io/rucksack/docs/#options) | |
+| **parser** | custom css parser if desired. pass `false` to use the default css parser | `sugarss` |
+| **minify** | Minifies the css output by removing excess spaces and line breaks | `false` |
 
 ### License & Contributing