stylelint-config-awzome/README.md

A shareable linting-config for stylelint.

# stylelint-config-awzome

This stylelint-config covers the code-style I personally like to use and have been used along on some projects before.

### Installing

To checkout the stylelint config with npm, just use this command:
`npm install --save-dev stylelint-config-awzome`

## Getting Started

Create the file `.stylelintrc` on the top level of your application.

Insert the following basic-configuration if you want to only use this config and our defined rules:
```
{
    "extends": "stylelint-config-awzome"
}
```

To adjust rules, head over to the official documentation of stylelint.


## Built With

* [stylelint](https://github.com/stylelint/stylelint) - The basic project of scss-linting
* [stylelint-config-recommended-scss](https://github.com/kristerkari/stylelint-config-recommended-scss) - Minimalistic set of rules for scss
* [stylelint-declaration-use-variable](https://github.com/sh-waqar/stylelint-declaration-use-variable) - Plugin to check the use of scss variable on declarations
* [stylelint-selector-tag-no-without-class](https://github.com/Moxio/stylelint-selector-tag-no-without-class) - Plugin to set class-name-usage for specific selectors

## Authors

* **Dominik Spiertz** - *Creator* - [dominikspiertz](https://github.com/dominikspiertz)