Add more documentation to the readme

cssstats · May 7, 2015 · acb99e9 · acb99e9
1 parent 6a51eeb
commit acb99e9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # postcss-cssstats [![Build Status](https://secure.travis-ci.org/cssstats/postcss-cssstats.png?branch=master)](https://travis-ci.org/cssstats/postcss-cssstats)
 
-A PostCSS plugin for cssstats.
+A PostCSS plugin for [cssstats](https://github.com/cssstats/cssstats).
 
 ## Installation
 
@@ -10,6 +10,10 @@ npm install --save postcss-cssstats
 
 ## Usage
 
+This plugin will return a cssstats object in the callback which can
+be used for css analysis. For more information on the stats object see
+the [cssstats documentation](https://github.com/cssstats/css-statistics#returned-object).
+
 ```javascript
 var postcss = require('postcss');
 var cssstats = require('postcss-cssstats');

diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "postcss-cssstats",
   "description": "A PostCSS plugin for cssstats.",
   "author": "John Otander",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "index.js",
   "directories": {
     "test": "test"