update docs

viqueen · May 24, 2023 · 2a53501 · 2a53501
1 parent 9ea7537
commit 2a53501
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -12,6 +12,33 @@ brew install nvm
 brew install yarn
 ```
 
+### development
+
+- build it, this ensures the text templates are copied to the dist folder
+
+```bash
+yarn build
+```
+
+- link it locally
+
+```bash
+yarn link
+```
+
+- build it in watch mode
+
+```bash
+yarn build --watch
+```
+
+- test your local changes on your other packages
+
+```bash
+cd my-other-package
+yarn link eslint-plugin-license-notice
+```
+
 ### house-keeping
 
 - build it

diff --git a/README.md b/README.md
@@ -17,3 +17,23 @@ yarn add eslint-plugin-license-notice -D -W
 ```
 
 ### use it
+
+- add the eslint plugin to your `.eslintrc.js`
+
+```javascript
+module.exports = {
+    ...,
+    plugins: [
+        'license-notice',
+    ],
+    rules: {
+        'license-notice/include': [
+            'error', {
+                license: 'Apache-2.0',
+                copyRightYear: '<year>',
+                copyRightName: '<name>'
+            }
+        ]
+    }
+}
+```