style: standardize quotation marks and formatting in README.md
All checks were successful
CI / build (push) Successful in 17s
CI / publish (push) Successful in 15s

This commit is contained in:
2025-09-06 19:36:14 +01:00
parent 356b70474c
commit 68f31018ef

View File

@@ -25,46 +25,46 @@ npm install @3t/bennc
### Using the BenncClient (Recommended)
```typescript
import { BenncClient, MessageTypes } from '@3t/bennc';
import { BenncClient, MessageTypes } from "@3t/bennc";
const client = new BenncClient({
url: 'wss://your-bennc-server.com',
url: "wss://your-bennc-server.com",
autoReconnect: true,
reconnectBackoff: 'exponential',
reconnectBackoff: "exponential",
reconnectDelay: 1000,
});
// Listen for events
client.addEventListener('connected', () => {
console.log('Connected to BENNC server');
client.addEventListener("connected", () => {
console.log("Connected to BENNC server");
// Subscribe to basic messages
client.subscribe(MessageTypes.Basic);
});
client.addEventListener('message:1', (event) => {
client.addEventListener("message:1", (event) => {
const { senderId, data } = event.detail;
console.log(`Message from ${senderId}:`, new TextDecoder().decode(data));
});
client.addEventListener('disconnected', (event) => {
console.log('Disconnected:', event.detail);
client.addEventListener("disconnected", (event) => {
console.log("Disconnected:", event.detail);
});
// Connect to server
await client.connect();
// Send a message
client.sendBasicMessage('Hello, BENNC!');
client.sendBasicMessage("Hello, BENNC!");
```
### Using Low-Level Protocol Functions
```typescript
import { packers, unpackers, MessageTypes } from '@3t/bennc';
import { packers, unpackers, MessageTypes } from "@3t/bennc";
// Pack a basic message
const messageData = new TextEncoder().encode('Hello World');
const messageData = new TextEncoder().encode("Hello World");
const packet = packers[MessageTypes.Basic](messageData);
// Unpack incoming message
@@ -82,7 +82,7 @@ interface BenncClientOptions {
url: string; // WebSocket server URL
protocols?: string[]; // WebSocket protocols
autoReconnect?: boolean; // Enable auto-reconnection (default: true)
reconnectBackoff?: 'constant' | 'exponential'; // Backoff strategy (default: 'exponential')
reconnectBackoff?: "constant" | "exponential"; // Backoff strategy (default: 'exponential')
reconnectDelay?: number; // Reconnection delay in ms (default: 1000)
maxReconnectAttempts?: number; // Max reconnection attempts (default: 10)
}