add local setup docs to readme, fixes whelk-io#102

telia-actions · Jun 2, 2021 · 8da56a6 · 8da56a6
1 parent 82c3c3a
commit 8da56a6
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -309,3 +309,25 @@ Reference: [Maven Settings > Active Profiles](https://maven.apache.org/settings.
 
 </settings>
 ````
+
+----
+
+## Local Setup
+
+See [CONTRIBUTING.md](Contributing) for guidelines for forking and contributing to this project.
+
+**Install Dependencies**
+
+`npm ci`
+
+**Run Linter**
+
+`npm run lint`
+
+**Run Unit-Tests**
+
+`npm test`
+
+**Create Distribution**
+
+`npm run build`