Skip to content

Commit

Permalink
feat: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rodoabad committed Apr 4, 2016
1 parent 4d32e9f commit 3c3be5f
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ You need to have `stylelint` and this config as part of your `devDependencies`.

## Usage

Add `stylelint-config-semantic` to your `extends` property in `.stylelintrc`.
### Load everything

To use all the rules all at once add `stylelint-config-semantic` to your `extends` property in `.stylelintrc`.

```json
{
Expand All @@ -24,6 +26,24 @@ Add `stylelint-config-semantic` to your `extends` property in `.stylelintrc`.
}
```

### Load a specific rule

Each rule for `stylelint-config-semantic` can be loaded individually if you only want to load a specific rule. They are all located in the `lib` folder.

Load the `color` and `general` rule set.

```json
{
"extends": [
"stylelint-config-semantic/lib/color",
"stylelint-config-semantic/lib/general"
]
}
```


### Override specific rules

To override the rules set by `stylelint-config-semantic` you need to define your own rules and set them as you see fit.

```json
Expand Down

0 comments on commit 3c3be5f

Please sign in to comment.