updated for SEO

Author: colecrouter

LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024 Cole Crouter
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -2,17 +2,23 @@
 
 > This project is not affiliated or based upon the original [web-push](https://github.com/web-push-libs/web-push) package or [web-push-lib](https://github.com/web-push-libs) organization.
 
-This package is aimed at being a lightweight replacement for [web-push](https://github.com/web-push-libs/web-push), as (at the time of writing) it relies on Node.js dependencies that are not available in the browser.
+Minimal, zero-dependency library for creating and sending Web Push (VAPID) notifications from environments without Node.js crypto shims — for example browsers, Cloudflare Workers, Deno, Bun, and other edge runtimes.
 
-## Installation
+Key features:
+
+- Runs in browsers, Cloudflare Workers, Deno, Bun, and Node
+- Zero dependencies; ESM-first and browser-friendly
+- VAPID key generation, serialization/deserialization
+- Payload encryption with aes128gcm (aesgcm partially supported)
+- Helper to generate the correct Web Push request headers and send the POST
+
+Install
 
 ```bash
 npm install web-push-browser
 ```
 
-## Example Usage
-
-### Subscribing a User
+Quick example — how to send a push notification from an edge runtime or browser environment
 
 ```ts
 import { fromBase64Url } from 'web-push-browser';
@@ -38,7 +44,7 @@ try {
 }
 ```
 
-### Sending a Push Notification
+## Sending a Push Notification
 
 ```ts
 import { sendNotification, deserializeVapidKeys } from 'web-push-browser';
@@ -84,4 +90,4 @@ console.log(serializedKeys);
 This package only supports the basic functionality. If you need more advanced features, such as proxies, custom headers, etc. you can access the internal functions to create your own requests.
 
 > [!NOTE]
-> `aesgcm` is not completely implemented in this package. Please use `aes128gcm` instead.
+> `aesgcm` is not completely implemented in this package. Please use `aes128gcm` instead.

package.json

@@ -1,8 +1,15 @@
 {
 	"name": "web-push-browser",
-	"version": "1.3.1",
-	"description": "Minimal library for sending notifications via the browser Push API",
+	"version": "1.4.0",
+	"description": "Zero-dependency Web Push (VAPID) for browsers, workers, Deno, Bun, and Node ESM — generate VAPID keys and send Push API notifications.",
 	"main": "build/index.js",
+	"types": "build/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./build/index.d.ts",
+			"import": "./build/index.js"
+		}
+	},
 	"devDependencies": {
 		"@types/jest": "^29.5.13",
 		"jest": "^29.7.0",
@@ -18,20 +25,46 @@
 	"author": "Cole Crouter",
 	"license": "ISC",
 	"type": "module",
+	"sideEffects": false,
 	"keywords": [
+		"web push",
 		"push",
+		"push api",
+		"push notifications",
 		"notifications",
-		"web-push",
+		"vapid",
+		"vapid keys",
+		"service worker",
+		"service-worker",
+		"subscription",
+		"push subscription",
+		"aes128gcm",
+		"aesgcm",
+		"encryption",
+		"payload encryption",
 		"browser",
-		"esm",
+		"workers",
+		"cloudflare workers",
+		"edge runtime",
+		"deno",
+		"bun",
 		"node",
 		"nodejs",
-		"cloudflare",
-		"deno",
-		"bun"
+		"esm",
+		"typescript",
+		"zero dependency"
 	],
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/colecrouter/web-push-browser"
-	}
+	},
+	"homepage": "https://github.com/colecrouter/web-push-browser#readme",
+	"bugs": {
+		"url": "https://github.com/colecrouter/web-push-browser/issues"
+	},
+	"files": [
+		"build",
+		"README.md",
+		"LICENSE"
+	]
 }