Skip to content

Commit 311fa9f

Browse files
committed
Make the README moar better
1 parent 3abc4a5 commit 311fa9f

File tree

1 file changed

+45
-10
lines changed

1 file changed

+45
-10
lines changed

README.md

Lines changed: 45 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,60 @@
1-
# Csscss
2-
31
[![Build Status](https://travis-ci.org/zmoazeni/csscss.png?branch=master)](https://travis-ci.org/zmoazeni/csscss)
42

5-
A CSS redundancy analyzer that analyzes redundancy. My first attempt was
6-
in Haskell with https://github.com/zmoazeni/csscss-haskell this is the
7-
second in Ruby.
3+
## What is it? ##
4+
5+
csscss will parse any CSS files you give it and let you know which
6+
rulesets have duplicated declarations.
7+
8+
## What is it for? ##
9+
10+
One of the best strategies for me to maintain CSS is to reduce
11+
duplication as much as possible. It's not a silver bullet, but it sure
12+
helps.
813

9-
## (Not ready yet) Installation
14+
To do that, you need to have all the rulesets in your head at all times.
15+
That's hard, csscss is easy. Let it tell you what is redundant.
1016

11-
(Soon) Install it as:
17+
## How do I use it? ##
18+
19+
First you need to install it. It is currently packaged as a ruby gem:
1220

1321
$ gem install csscss
1422

15-
## Usage
23+
Then you can run it in at the command line against CSS files.
24+
25+
$ csscss path/to/styles.css path/to/other-styles.css
26+
27+
Run it in a verbose mode to see all the duplicated styles.
28+
29+
$ csscss -v path/to/styles.css
30+
31+
You can also choose a minimum number of matches, which will ignore any
32+
rulesets that have fewer matches.
33+
34+
$ csscss -n 10 -v path/to/style.css # ignores rulesets with < 10 matches
35+
36+
## I found bugs ##
37+
38+
This is still a new and evolving project. I heartily welcome feedback.
39+
If you find any issues, please report them on
40+
[github](https://github.com/zmoazeni/csscss/issues).
41+
42+
Please include the smallest CSS snippet to describe the issue and the
43+
output you expect to see.
44+
45+
## Who are you? ##
46+
47+
My name is [Zach Moazeni](https://twitter.com/zmoazeni). I work for [an
48+
awesome company](http://www.getharvest.com/), which [is
49+
hiring!](http://www.getharvest.com/careers).
1650

17-
TODO: Write usage instructions here
51+
## I'm a dev, I can help ##
1852

19-
## Contributing
53+
Awesome! Thanks! Here are the steps I ask:
2054

2155
1. Fork it
2256
2. Create your feature branch (`git checkout -b my-new-feature`)
2357
3. Commit your changes (`git commit -am 'Add some feature'`)
58+
4. Make sure the tests pass (`bundle exec rake test`)
2459
4. Push to the branch (`git push origin my-new-feature`)
2560
5. Create new Pull Request

0 commit comments

Comments
 (0)