Merge pull request reworkcss#25 from andreypopp/master

Add docs

Author: tj

History.md

@@ -1,3 +1,7 @@
+1.4.0 / 2013-XX-XX
+==================
+
+ * add source map generation
 
 1.3.2 / 2013-10-18 
 ==================

Readme.md

@@ -2,6 +2,32 @@
 
   CSS compiler using the AST provided by [css-parse](https://github.com/visionmedia/css-parse).
 
+## Usage
+
+`css-stringify` exports a single function which dumps CSS AST:
+
+    var stringify = require('css-stringify');
+    var parse = require('css-parse');
+
+    var ast = parse('body { font-size: 12px; }');
+
+    var str = stringify(ast);
+
+To get compressed output pass `compress` option:
+
+    var compressed = stringify(ast, {compress: true});
+
+To get a source map pass `sourcemap` option:
+
+    var ast = parse('body { font-size: 12px; }', {position: true});
+    var result = stringify(ast, {sourcemap: true});
+
+    result.code // string with CSS
+    result.map // source map
+
+Note that the AST should contain position information (`position` option of
+`css-parse` set to `true`).
+
 ## Performance
 
   Formats 15,000 lines of CSS (2mb) in 23ms on my macbook air.

index.js

@@ -11,6 +11,14 @@ var Identity = require('./lib/identity');
  *
  * @param {Object} node
  * @param {Object} [options]
+ * @param {Boolean} [options.sourcemap]  generate source map,
+ *                  if set to true this will change return value to
+ *                  `{code: '...', map: {...}}`, `node` argument should contain
+ *                  position information (e.g.  parsed by css-parse with
+ *                  `position` option set to `true`)
+ * @param {Boolean} [options.compress] compress output (ignores indent option)
+ * @param {String} [options.indent] a string used for indents (defaults to 2 spaces)
+ *
  * @return {String}
  * @api public
  */