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

Add more documentation to the readme #5

Merged
merged 1 commit into from
May 7, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add more documentation to the readme
  • Loading branch information
johno committed May 7, 2015
commit acb99e9adc8992605a3e26eae29d08ab9e30ad64
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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');
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down