@meshwhisper/service-worker 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,29 @@
+# @meshwhisper/service-worker
+
+Web Push service worker for [MeshWhisper](https://github.com/twotwoonethree/meshwhisper) PWAs. Receives the content-free wake signal sent by [`@meshwhisper/push-service`](https://www.npmjs.com/package/@meshwhisper/push-service), shows a notification, and routes clicks back into your app — where the SDK pulls and decrypts the actual message.
+
+## Install
+
+```bash
+npm install @meshwhisper/service-worker
+cp node_modules/@meshwhisper/service-worker/dist/meshwhisper-sw.js public/
+```
+
+The worker must be served from your domain **root** (`https://myapp.com/meshwhisper-sw.js`). Register it and subscribe before initializing the SDK:
+
+```ts
+const registration = await navigator.serviceWorker.register('/meshwhisper-sw.js');
+const subscription = await registration.pushManager.subscribe({
+  userVisibleOnly: true,
+  applicationServerKey: vapidPublicKeyBytes,
+});
+
+await MeshWhisper.init({
+  // ...
+  push: { platform: 'webpush', subscription: subscription.toJSON() },
+});
+```
+
+The full wiring is generated for you by `npx @meshwhisper/cli init` (browser/PWA option) and walked through in the [getting-started guide](https://github.com/twotwoonethree/meshwhisper/blob/main/docs/getting-started.md).
+
+MIT

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@meshwhisper/service-worker",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "MeshWhisper service worker — handles Web Push wake events for PWAs",
   "type": "module",
   "main": "dist/meshwhisper-sw.js",
-  "files": ["dist", "src"],
-  "publishConfig": { "access": "public" },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "prepublishOnly": "npm run build",
     "build": "esbuild src/index.ts --bundle --platform=browser --outfile=dist/meshwhisper-sw.js --format=iife"