Skip to content
This repository was archived by the owner on Mar 28, 2018. It is now read-only.

Commit acb99e9

Browse files
committed
Add more documentation to the readme
1 parent 6a51eeb commit acb99e9

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# postcss-cssstats [![Build Status](https://secure.travis-ci.org/cssstats/postcss-cssstats.png?branch=master)](https://travis-ci.org/cssstats/postcss-cssstats)
22

3-
A PostCSS plugin for cssstats.
3+
A PostCSS plugin for [cssstats](https://github.com/cssstats/cssstats).
44

55
## Installation
66

@@ -10,6 +10,10 @@ npm install --save postcss-cssstats
1010

1111
## Usage
1212

13+
This plugin will return a cssstats object in the callback which can
14+
be used for css analysis. For more information on the stats object see
15+
the [cssstats documentation](https://github.com/cssstats/css-statistics#returned-object).
16+
1317
```javascript
1418
var postcss = require('postcss');
1519
var cssstats = require('postcss-cssstats');

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "postcss-cssstats",
33
"description": "A PostCSS plugin for cssstats.",
44
"author": "John Otander",
5-
"version": "1.0.0",
5+
"version": "1.0.1",
66
"main": "index.js",
77
"directories": {
88
"test": "test"

0 commit comments

Comments
 (0)