updated README

Author: tiagoloureiro

.github/workflows/ci.yml

@@ -4,13 +4,13 @@ on:
   pull_request:
     branches:
       - 'main'
-      - 'release/*'
       - 'dependabot/*'
 
   push:
     branches:
       - 'main'
-      - 'release/*'
+    tags:
+      - '*'
 
 concurrency:
   group: ${{ github.head_ref || github.run_id }}
@@ -36,18 +36,3 @@ jobs:
         run: npm ci
       - name: Run tests
         run: npm run lint
-  build:
-    runs-on: ubuntu-latest
-    needs: lint
-    steps:
-      - uses: actions/checkout@v4
-      # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 'lts/*'
-          cache: 'npm'
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_REGISTRY_TOKEN }}

README.md

@@ -1,3 +1,21 @@
-# stylelint-config-dipcode
+# Dipcode Stylelint config
 
-Shareable stylelint config for CSS and SCSS, following Dipcode code style.
+> Shareable Stylelint config for CSS and SCSS, following Dipcode code style.
+
+- [Usage](#usage)
+- [Links](#links)
+
+## Usage
+
+Our default export contains all of our Stylelint rules, along with specific plugins for SCSS syntax.
+
+1. Run `npm install stylelint @dipcode/stylelint-config --save-dev`
+2. Add `"extends": "@dipcode/stylelint-config"` to your `.stylelintrc`
+
+## Links
+
+- [Stylelint](https://stylelint.io/)
+- [stylelint-config-standard-scss](https://www.npmjs.com/package/stylelint-config-standard-scss)
+- [stylelint-config-prettier-scss](https://www.npmjs.com/package/stylelint-config-prettier-scss)
+- [stylelint-order](https://www.npmjs.com/package/stylelint-order)
+- [stylelint-declaration-strict-value](https://www.npmjs.com/package/stylelint-declaration-strict-value)