docs

Author: tj

Readme.md

@@ -5,25 +5,37 @@
 
 ## Example
 
-js:
+css:
 
-```js
-var parse = require('css-parse')
-parse('tobi { name: "tobi" }')
+```css
+body {
+  background: #eee;
+  color: #888;
+}
 ```
 
-object returned:
+parse tree:
 
 ```json
 {
+  "type": "stylesheet",
   "stylesheet": {
     "rules": [
       {
-        "selectors": ["tobi"],
+        "type": "rule",
+        "selectors": [
+          "body"
+        ],
         "declarations": [
           {
-            "property": "name",
-            "value": "tobi"
+            "type": "declaration",
+            "property": "background",
+            "value": "#eee"
+          },
+          {
+            "type": "declaration",
+            "property": "color",
+            "value": "#888"
           }
         ]
       }
@@ -32,31 +44,70 @@ object returned:
 }
 ```
 
-## Performance
-
-  Parsed 15,000 lines of CSS (2mb) in 40ms on my macbook air.
-
-## License 
+parse tree with `.position` enabled:
 
-(The MIT License)
+```json
+{
+  "type": "stylesheet",
+  "stylesheet": {
+    "rules": [
+      {
+        "type": "rule",
+        "selectors": [
+          "body"
+        ],
+        "declarations": [
+          {
+            "type": "declaration",
+            "property": "background",
+            "value": "#eee",
+            "position": {
+              "start": {
+                "line": 3,
+                "column": 3
+              },
+              "end": {
+                "line": 3,
+                "column": 19
+              }
+            }
+          },
+          {
+            "type": "declaration",
+            "property": "color",
+            "value": "#888",
+            "position": {
+              "start": {
+                "line": 4,
+                "column": 3
+              },
+              "end": {
+                "line": 4,
+                "column": 14
+              }
+            }
+          }
+        ],
+        "position": {
+          "start": {
+            "line": 2,
+            "column": 1
+          },
+          "end": {
+            "line": 5,
+            "column": 2
+          }
+        }
+      }
+    ]
+  }
+}
+```
 
-Copyright (c) 2012 TJ Holowaychuk <tj@vision-media.ca>
+## Performance
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+  Parsed 15,000 lines of CSS (2mb) in 40ms on my macbook air.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+## License
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  MIT