Skip to content

Commit 0497c7a

Browse files
committed
Update README.md
1 parent 1edba4f commit 0497c7a

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
1-
# Tool for sorting CSS properties
1+
# Tool for beautify CSS
22

3-
JavaScript version of [CSScomb](https://github.com/csscomb/CSScomb/)
3+
## Installation
4+
5+
```
6+
npm install csscomb
7+
```
8+
9+
To run `csscomb`, you can use the following command from the project root:
10+
11+
```
12+
./node_modules/.bin/csscomb path[ path[...]]
13+
```
14+
15+
```
16+
$ ./node_modules/.bin/csscomb --help
17+
18+
Usage: csscomb [options] <file ...>
19+
20+
Options:
21+
22+
-h, --help output usage information
23+
-V, --version output the version number
24+
-c, --config [path] configuration file path
25+
```
26+
27+
## Configuration
28+
29+
`csscomb` is configured using `.csscomb.json` file, located in the project root.
30+
31+
Example configuration:
32+
33+
```javascript
34+
{
35+
"exclude": ["node_modules/**"],
36+
"strip-spaces": true
37+
}
38+
```
39+
40+
## Tests
41+
42+
Run `npm test` for tests.
43+
44+
## Other projects
45+
* https://github.com/senchalabs/cssbeautify
46+
* http://www.codebeautifier.com/

0 commit comments

Comments
 (0)