docs: polish README, CHANGELOG, and package metadata

Fix scoped badge URLs and imports, add missing CHANGELOG entries,
add examples to files array, and create example files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: vveerrgg

CHANGELOG.md

@@ -7,7 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.3.14] - 2025-01-13
+## [0.3.14] - 2025-02-19
+
+### Changed
+- Updated dependencies and fixed broken validateResponse import
+- Fixed import from nostr-crypto-utils
+
+## [0.3.13] - 2025-01-13
 
 ### Added
 - Browser support via webpack bundle
@@ -20,10 +26,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated package.json to include browser field
 - Enhanced build process to support browser environments
 
+## [0.3.11] - 2025-01-05
+
+### Added
+- CommonJS support and included dist/ in package
+
 ## [0.3.10] - 2025-01-02
 
 ### Changed
 - Updated nostr-crypto-utils dependency to ^0.4.10 for better ESM compatibility
+- Updated to use npm-published nostr-crypto-utils package
 
 ## [0.3.9] - 2025-01-02
 

README.md

@@ -1,7 +1,7 @@
 # nostr-websocket-utils
 
-[![npm version](https://img.shields.io/npm/v/@humanjavaenterprises/nostr-websocket-utils.svg)](https://www.npmjs.com/package/@humanjavaenterprises/nostr-websocket-utils)
-[![License](https://img.shields.io/npm/l/@humanjavaenterprises/nostr-websocket-utils.svg)](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/LICENSE)
+[![npm version](https://img.shields.io/npm/v/nostr-websocket-utils.svg)](https://www.npmjs.com/package/nostr-websocket-utils)
+[![License](https://img.shields.io/npm/l/nostr-websocket-utils.svg)](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/LICENSE)
 [![Build Status](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/workflows/CI/badge.svg)](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/actions)
 [![Documentation](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/workflows/Documentation/badge.svg)](https://humanjavaenterprises.github.io/nostr-websocket-utils/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org)
@@ -103,7 +103,7 @@ await client.connect();
 ### Creating a Nostr WebSocket Server
 
 ```typescript
-import { createNostrServer } from '@humanjavaenterprises/nostr-websocket-utils';
+import { createNostrServer } from 'nostr-websocket-utils';
 
 const server = await createNostrServer(8080, {
   logger: console,

examples/basic-client.ts

@@ -0,0 +1,40 @@
+/**
+ * Basic Client Example — nostr-websocket-utils
+ *
+ * Demonstrates connecting to a relay and subscribing to events.
+ */
+import { NostrWSClient } from 'nostr-websocket-utils';
+
+async function main() {
+  // Create a WebSocket client connected to a relay
+  const client = new NostrWSClient('wss://relay.damus.io', {
+    heartbeatInterval: 30000,
+    handlers: {
+      message: async (msg) => {
+        console.log('Received message:', JSON.stringify(msg, null, 2));
+      },
+      error: (err) => {
+        console.error('Connection error:', err);
+      },
+      close: () => {
+        console.log('Connection closed');
+      },
+    },
+  });
+
+  // Connect to the relay
+  await client.connect();
+  console.log('Connected to relay');
+
+  // Subscribe to text note events (kind 1) from specific authors
+  client.subscribe('my-subscription', {
+    filter: {
+      kinds: [1],
+      limit: 10,
+    },
+  });
+
+  console.log('Subscribed to text notes. Listening for events...');
+}
+
+main().catch(console.error);

examples/server.ts

@@ -0,0 +1,38 @@
+/**
+ * Server Example — nostr-websocket-utils
+ *
+ * Demonstrates creating a basic Nostr WebSocket server.
+ */
+import { createNostrServer } from 'nostr-websocket-utils';
+
+async function main() {
+  const port = 8080;
+
+  const server = await createNostrServer(port, {
+    heartbeatInterval: 30000,
+    handlers: {
+      message: async (ws, msg) => {
+        console.log('Received message from client:', JSON.stringify(msg, null, 2));
+
+        // Echo the message type back
+        if (msg.type === 'EVENT') {
+          console.log('Event received:', msg.data);
+        } else if (msg.type === 'REQ') {
+          console.log('Subscription request:', msg.data);
+        } else if (msg.type === 'CLOSE') {
+          console.log('Subscription closed:', msg.data);
+        }
+      },
+    },
+  });
+
+  console.log(`Nostr WebSocket server listening on port ${port}`);
+
+  // Broadcast a message to all connected clients
+  server.broadcast({
+    type: 'NOTICE',
+    data: 'Welcome to the Nostr relay!',
+  });
+}
+
+main().catch(console.error);

package.json

@@ -83,6 +83,7 @@
   },
   "files": [
     "dist",
+    "examples/**/*",
     "README.md",
     "LICENSE"
   ],