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:
authorMartijn Cuppens <martijn.cuppens@intracto.com>2018-12-30 19:00:09 +0300
committerXhmikosR <xhmikosr@gmail.com>2019-01-05 19:23:42 +0300
commitfc3b915a6973c9a4fa5d06bd4492f20398a26ef6 (patch)
tree92586a8467740826d64159532b6a61469962660b /README.md
parent8705c5a98d7ef7abf1cd2bbd239ad54e9773b0b3 (diff)
Implement our Stylelint configs for css and scss.
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"
+}
+```