Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/stylelint-config-twbs-bootstrap.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index b0e5d9a..695eb42 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
# stylelint-config-bootstrap
-Stylelint config for Bootstrap
+Default stylelint config used by Bootstrap.
+
+## Installation
+
+```bash
+npm install stylelint-config-bootstrap --save-dev
+# Or with yarn:
+yarn add stylelint-config-bootstrap --dev
+```
+
+## Usage
+
+We provide a config for both CSS and SCSS. You can choose which one you would like to extend in your configuration:
+
+### CSS
+
+```json
+{
+ "extends": "stylelint-config-bootstrap/css"
+}
+```
+
+### SCSS
+
+```json
+{
+ "extends": "stylelint-config-bootstrap/scss"
+}
+```