.

Author: lymperis-e

README.md

@@ -257,6 +257,23 @@ stereonet.setStyle("data_plane", { stroke: "#00ff00", "stroke-width": "5px" });
 
 ---
 
+
+## Development
+
+### Publish to NPM
+The library is built on Github actions. A relase is automatically published to NPM using [semantic-release](https://github.com/semantic-release/semantic-release). Deployments are triggered when pushing on `main` branch with a commit message containting `feat`, `fix`, or `perf` (see the [docs](https://semantic-release.gitbook.io/semantic-release/recipes/release-workflow/distribution-channels))
+
+
+### Github Pages
+
+To update the example on Github pages, run the following command:
+
+```bash
+npm run deploy:gh-pages
+```
+
+---
+
 ## Acknowledgements
 
 - Vite library-mode setup bootstrapped using [kbysiec/vite-vanilla-ts-lib-starter](https://github.com/kbysiec/vite-vanilla-ts-lib-starter/).

package-lock.json

@@ -28,6 +28,8 @@
   "scripts": {
     "dev": "vite --host",
     "build": "vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts && copyfiles ./package.json build && copyfiles ./LICENSE.md build",
+    "build:gh-pages": "vite build --mode=example",
+    "deploy:gh-pages": "npm run build:gh-pages && gh-pages -d dist",
     "semantic-release": "semantic-release",
     "test": "vitest",
     "test:coverage": "vitest --coverage",
@@ -53,6 +55,7 @@
     "eslint": "^9.21.0",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.2.3",
+    "gh-pages": "^6.3.0",
     "jiti": "^2.4.2",
     "lint-staged": "^15.4.3",
     "postcss": "^8.5.3",