miaw-core 1.1.0 → 1.2.0

package/docs/USAGE.md

@@ -14,10 +14,15 @@ This document covers all current capabilities of Miaw Core. It will be updated a
 - [Configuration](#configuration)
 - [Authentication](#authentication)
 - [Sending Messages](#sending-messages)
+- [Media Messages](#media-messages)
 - [Advanced Messaging](#advanced-messaging)
+- [Contact & Validation](#contact--validation)
 - [Group Management](#group-management)
 - [Profile Management](#profile-management)
-- [Business & Social Features](#business--social-features-v090)
+- [UX & Presence](#ux--presence)
+- [Business Features](#business-features)
+- [Newsletter/Channel Features](#newsletterchannel-features)
+- [Data Retrieval](#data-retrieval)
 - [Receiving Messages](#receiving-messages)
 - [Connection Management](#connection-management)
 - [Multiple Instances](#multiple-instances)
@@ -25,6 +30,8 @@ This document covers all current capabilities of Miaw Core. It will be updated a
 - [Event Reference](#event-reference)
 - [Error Handling](#error-handling)
 - [TypeScript Usage](#typescript-usage)
+- [LID Privacy Support](#lid-privacy-support)
+- [Debugging](#debugging)
 
 ## Installation
 
@@ -85,6 +92,12 @@ const client = new MiawClient({
   autoReconnect: true, // Default: true
   maxReconnectAttempts: 10, // Default: Infinity
   reconnectDelay: 5000, // Default: 3000 (ms)
+
+  // Advanced timeout configurations
+  stuckStateTimeout: 30000, // Default: 30000 (ms)
+  qrGracePeriod: 30000, // Default: 30000 (ms)
+  qrScanTimeout: 60000, // Default: 60000 (ms)
+  connectionTimeout: 120000, // Default: 120000 (ms)
 });
 ```
 
@@ -98,6 +111,10 @@ const client = new MiawClient({
 | `autoReconnect`        | `boolean` | `true`         | Auto-reconnect on connection loss                   |
 | `maxReconnectAttempts` | `number`  | `Infinity`     | Maximum reconnection attempts                       |
 | `reconnectDelay`       | `number`  | `3000`         | Delay between reconnection attempts in milliseconds |
+| `stuckStateTimeout`    | `number`  | `30000`        | Timeout for detecting stuck connection state        |
+| `qrGracePeriod`        | `number`  | `30000`        | QR code grace period                                |
+| `qrScanTimeout`        | `number`  | `60000`        | QR code scan timeout                                |
+| `connectionTimeout`    | `number`  | `120000`       | Connection establishment timeout                    |
 
 ## Authentication
 
@@ -130,13 +147,37 @@ await client.connect(); // Uses saved session
 
 Sessions are stored in: `{sessionPath}/{instanceId}/`
 
-### Logout
+### Logout vs Disconnect
 
-To logout and clear session:
+Miaw Core provides two ways to end a session:
 
 ```typescript
+// Disconnect: Preserves session, can reconnect without QR
 await client.disconnect();
-// Then manually delete: ./sessions/{instanceId}/
+
+// Logout: Clears session, next connect() requires new QR code
+await client.logout();
+```
+
+**`disconnect()`**:
+
+- Closes the connection but preserves session files
+- You can call `connect()` again without scanning a new QR code
+- Use when temporarily stopping the bot
+
+**`logout()`**:
+
+- Sends logout request to WhatsApp servers
+- Clears local session files
+- Next `connect()` will require scanning a new QR code
+- Use when you want to sign out completely
+
+### Clear Session Manually
+
+```typescript
+// Clear session data without logging out from WhatsApp servers
+const cleared = client.clearSession();
+console.log("Session cleared:", cleared);
 ```
 
 ## Sending Messages
@@ -171,13 +212,123 @@ await client.sendText("1234567890@s.whatsapp.net", "Hello");
 await client.sendText("123456789@g.us", "Hello group!");
 ```
 
-### Send to Groups
+**Phone number format**: Use international format without `+` or leading zeros:
+
+- ✅ Correct: `6281234567890`
+- ❌ Wrong: `+6281234567890`, `081234567890`
+
+### Reply to Messages
+
+```typescript
+client.on("message", async (msg) => {
+  // Reply to the received message
+  await client.sendText(msg.from, "This is a reply!", { quoted: msg });
+});
+```
+
+## Media Messages
+
+### Send Image
+
+```typescript
+// From file path
+await client.sendImage("1234567890", "./image.jpg", {
+  caption: "Check this out!",
+});
+
+// From URL
+await client.sendImage("1234567890", "https://example.com/image.jpg", {
+  caption: "Image from URL",
+});
+
+// From Buffer
+const imageBuffer = fs.readFileSync("./image.png");
+await client.sendImage("1234567890", imageBuffer, {
+  caption: "Image from buffer",
+});
+
+// View-once image
+await client.sendImage("1234567890", "./secret.jpg", {
+  caption: "View once only!",
+  viewOnce: true,
+});
+```
+
+### Send Document
+
+```typescript
+// From file path (filename auto-detected)
+await client.sendDocument("1234567890", "./report.pdf", {
+  caption: "Here's the report",
+});
+
+// With custom filename
+await client.sendDocument("1234567890", documentBuffer, {
+  fileName: "custom-name.pdf",
+  mimetype: "application/pdf",
+  caption: "Custom document",
+});
+```
+
+### Send Video
+
+```typescript
+// Regular video
+await client.sendVideo("1234567890", "./video.mp4", {
+  caption: "Watch this!",
+});
+
+// View-once video
+await client.sendVideo("1234567890", "./secret-video.mp4", {
+  viewOnce: true,
+});
+
+// GIF playback (loops, no audio)
+await client.sendVideo("1234567890", "./animation.mp4", {
+  gifPlayback: true,
+});
+
+// Video note (circular, like Telegram)
+await client.sendVideo("1234567890", "./note.mp4", {
+  ptv: true,
+});
+```
 
-Same API for individual and group chats:
+### Send Audio
 
 ```typescript
-// Send to group (use group JID)
-await client.sendText("123456789@g.us", "Hello everyone!");
+// Regular audio file
+await client.sendAudio("1234567890", "./song.mp3");
+
+// Voice note (push-to-talk)
+await client.sendAudio("1234567890", "./voice.ogg", {
+  ptt: true, // Shows as voice message
+});
+
+// With custom mimetype
+await client.sendAudio("1234567890", audioBuffer, {
+  mimetype: "audio/ogg; codecs=opus",
+  ptt: true,
+});
+```
+
+### Download Media
+
+Download media from received messages:
+
+```typescript
+client.on("message", async (msg) => {
+  // Check if it's a media message
+  if (["image", "video", "audio", "document", "sticker"].includes(msg.type)) {
+    const buffer = await client.downloadMedia(msg);
+
+    if (buffer) {
+      // Save to file
+      fs.writeFileSync(`./downloads/${msg.id}.${getExtension(msg.type)}`, buffer);
+      console.log("Media downloaded!");
+    }
+  }
+});
 ```
 
 ## Advanced Messaging
@@ -239,11 +390,6 @@ await client.forwardMessage(msg, "123456789@g.us");
 Edit your own sent messages (within WhatsApp's 15-minute window):
 
 ```typescript
-// Send a message and keep the reference
-const result = await client.sendText("1234567890", "Hello, Wordl!");
-
-// Later, fix the typo by editing
-// Note: You need to store/retrieve the sent message object
 client.on("message", async (msg) => {
   if (msg.fromMe && msg.text === "Hello, Wordl!") {
     await client.editMessage(msg, "Hello, World!");
@@ -279,455 +425,395 @@ await client.deleteMessageForMe(msg, true); // deleteMedia = true (default)
 await client.deleteMessageForMe(msg, false); // keep media files
 ```
 
-### Auto-React Bot Example
+## Contact & Validation
 
-Bot that automatically reacts to messages:
+### Check WhatsApp Registration
 
 ```typescript
-client.on("message", async (msg) => {
-  if (msg.fromMe) return;
-
-  // React based on keywords
-  const text = msg.text?.toLowerCase() || "";
+// Check single number
+const result = await client.checkNumber("6281234567890");
+if (result.exists) {
+  console.log("Registered on WhatsApp:", result.jid);
+} else {
+  console.log("Not on WhatsApp");
+}
 
-  if (text.includes("thank")) {
-    await client.sendReaction(msg, "🙏");
-  } else if (text.includes("love")) {
-    await client.sendReaction(msg, "❤️");
-  } else if (text.includes("funny") || text.includes("lol")) {
-    await client.sendReaction(msg, "😂");
-  }
+// Check multiple numbers
+const results = await client.checkNumbers([
+  "6281234567890",
+  "6289876543210",
+]);
+results.forEach((r, i) => {
+  console.log(`Number ${i}: ${r.exists ? r.jid : "Not registered"}`);
 });
 ```
 
-## Group Management
+### Get Contact Information
 
-Full group administration capabilities for creating and managing WhatsApp groups.
+```typescript
+// Basic contact info
+const info = await client.getContactInfo("6281234567890");
+if (info) {
+  console.log("JID:", info.jid);
+  console.log("Phone:", info.phone);
+  console.log("Status:", info.status);
+  console.log("Is Business:", info.isBusiness);
+}
 
-### Create Group
+// Full contact profile
+const profile = await client.getContactProfile("6281234567890");
+if (profile) {
+  console.log("Name:", profile.name);
+  console.log("Status:", profile.status);
+  console.log("Picture URL:", profile.pictureUrl);
+  if (profile.isBusiness) {
+    console.log("Business:", profile.business?.description);
+  }
+}
 
-Create a new WhatsApp group:
+// Business profile only
+const business = await client.getBusinessProfile("6281234567890");
+if (business) {
+  console.log("Description:", business.description);
+  console.log("Category:", business.category);
+  console.log("Website:", business.website);
+}
+```
+
+### Get Profile Picture
 
 ```typescript
-const result = await client.createGroup("My New Group", [
-  "1234567890", // Phone number
-  "0987654321",
-]);
+// Preview quality
+const previewUrl = await client.getProfilePicture("6281234567890");
 
-if (result.success) {
-  console.log("Group created:", result.groupJid);
-  console.log("Group name:", result.groupInfo?.name);
-  console.log("Participants:", result.groupInfo?.participantCount);
-}
+// High resolution
+const fullUrl = await client.getProfilePicture("6281234567890", true);
 ```
 
-### Add Participants
-
-Add members to an existing group (requires admin):
+### Manage Contacts
 
 ```typescript
-const results = await client.addParticipants("123456789@g.us", [
-  "1234567890",
-  "0987654321",
-]);
+// Add or edit a contact
+const result = await client.addOrEditContact({
+  phone: "6281234567890",
+  name: "John Doe",
+  firstName: "John",
+  lastName: "Doe",
+});
 
-for (const result of results) {
-  if (result.success) {
-    console.log(`Added: ${result.jid}`);
-  } else {
-    console.log(`Failed to add ${result.jid}: ${result.status}`);
-  }
+if (result.success) {
+  console.log("Contact saved!");
 }
+
+// Remove a contact
+await client.removeContact("6281234567890");
 ```
 
-### Remove Participants
+## Group Management
 
-Remove members from a group (requires admin):
+### Get Group Information
 
 ```typescript
-const results = await client.removeParticipants("123456789@g.us", [
-  "1234567890",
-]);
+// Get group metadata
+const info = await client.getGroupInfo("123456789@g.us");
+if (info) {
+  console.log("Name:", info.name);
+  console.log("Description:", info.description);
+  console.log("Owner:", info.owner);
+  console.log("Participants:", info.participantCount);
+  console.log("Admins only messages:", info.announce);
+  console.log("Admins only edit info:", info.restrict);
+}
 
-results.forEach((r) =>
-  console.log(`${r.jid}: ${r.success ? "Removed" : r.status}`)
-);
+// Get participants
+const participants = await client.getGroupParticipants("123456789@g.us");
+participants?.forEach((p) => {
+  console.log(`${p.jid}: ${p.role}`);
+});
 ```
 
-### Leave Group
-
-Leave a group:
+### Create Group
 
 ```typescript
-const result = await client.leaveGroup("123456789@g.us");
+const result = await client.createGroup("My New Group", [
+  "6281234567890",
+  "6289876543210",
+]);
+
 if (result.success) {
-  console.log("Left the group");
+  console.log("Group created:", result.groupJid);
+  console.log("Group name:", result.groupInfo?.name);
+  console.log("Participants:", result.groupInfo?.participantCount);
 }
 ```
 
-### Promote/Demote Admins
-
-Manage group admin roles:
+### Manage Participants
 
 ```typescript
-// Promote member to admin
-const promoteResults = await client.promoteToAdmin("123456789@g.us", [
-  "1234567890",
+// Add participants
+const addResults = await client.addParticipants("123456789@g.us", [
+  "6281234567890",
 ]);
+addResults.forEach((r) => {
+  console.log(`${r.jid}: ${r.success ? "Added" : r.status}`);
+});
 
-// Demote admin to member
-const demoteResults = await client.demoteFromAdmin("123456789@g.us", [
-  "1234567890",
+// Remove participants
+const removeResults = await client.removeParticipants("123456789@g.us", [
+  "6281234567890",
 ]);
-```
 
-### Update Group Name
+// Promote to admin
+await client.promoteToAdmin("123456789@g.us", ["6281234567890"]);
 
-Change the group name/subject:
+// Demote from admin
+await client.demoteFromAdmin("123456789@g.us", ["6281234567890"]);
 
-```typescript
-const result = await client.updateGroupName("123456789@g.us", "New Group Name");
-if (result.success) {
-  console.log("Group name updated");
-}
+// Leave group
+await client.leaveGroup("123456789@g.us");
 ```
 
-### Update Group Description
-
-Set or clear group description:
+### Update Group Settings
 
 ```typescript
-// Set description
+// Update name
+await client.updateGroupName("123456789@g.us", "New Group Name");
+
+// Update description
 await client.updateGroupDescription(
   "123456789@g.us",
-  "Welcome to our group! Please read the rules."
+  "Welcome to our group!"
 );
 
-// Clear description (pass undefined)
+// Clear description
 await client.updateGroupDescription("123456789@g.us");
-```
-
-### Update Group Picture
 
-Change the group profile picture:
-
-```typescript
-// From file path
+// Update picture
 await client.updateGroupPicture("123456789@g.us", "./group-icon.jpg");
-
-// From URL
-await client.updateGroupPicture(
-  "123456789@g.us",
-  "https://example.com/image.jpg"
-);
-
-// From Buffer
-const imageBuffer = fs.readFileSync("./image.png");
-await client.updateGroupPicture("123456789@g.us", imageBuffer);
 ```
 
 ### Group Invite Links
 
-Manage group invite links:
-
 ```typescript
 // Get invite link
 const link = await client.getGroupInviteLink("123456789@g.us");
 console.log("Invite link:", link);
 // Output: https://chat.whatsapp.com/AbCdEfGhIjK
 
-// Revoke current link and get new one
+// Revoke and get new link
 const newLink = await client.revokeGroupInvite("123456789@g.us");
-console.log("New invite link:", newLink);
-```
-
-### Join Group via Invite
-
-Accept a group invitation:
-
-```typescript
-// Accept with full URL
-const groupJid = await client.acceptGroupInvite(
-  "https://chat.whatsapp.com/AbCdEfGhIjK"
-);
 
+// Accept invite
+const groupJid = await client.acceptGroupInvite("https://chat.whatsapp.com/AbCdEfGhIjK");
 // Or just the code
 const groupJid2 = await client.acceptGroupInvite("AbCdEfGhIjK");
 
-if (groupJid) {
-  console.log("Joined group:", groupJid);
-}
-```
-
-### Preview Group from Invite
-
-Get group info before joining:
-
-```typescript
-const info = await client.getGroupInviteInfo("AbCdEfGhIjK");
-
-if (info) {
-  console.log("Group name:", info.name);
-  console.log("Description:", info.description);
-  console.log("Members:", info.participantCount);
-  console.log("Created:", new Date(info.createdAt! * 1000));
+// Preview group before joining
+const preview = await client.getGroupInviteInfo("AbCdEfGhIjK");
+if (preview) {
+  console.log("Name:", preview.name);
+  console.log("Members:", preview.participantCount);
 }
 ```
 
-### Group Admin Bot Example
-
-Bot that manages group membership:
-
-```typescript
-client.on("message", async (msg) => {
-  if (!msg.isGroup || msg.fromMe) return;
-
-  const command = msg.text?.toLowerCase();
-  const groupJid = msg.from;
-
-  if (command === "!invite") {
-    const link = await client.getGroupInviteLink(groupJid);
-    await client.sendText(groupJid, `Join link: ${link}`);
-  }
-
-  if (command === "!groupinfo") {
-    const info = await client.getGroupInfo(groupJid);
-    if (info) {
-      await client.sendText(
-        groupJid,
-        `Group: ${info.name}\nMembers: ${info.participantCount}\nDescription: ${
-          info.description || "None"
-        }`
-      );
-    }
-  }
-});
-```
-
 ## Profile Management
 
-Customize your bot's WhatsApp profile.
-
 ### Update Profile Picture
 
-Change your profile picture:
-
 ```typescript
 // From file path
-const result = await client.updateProfilePicture("./my-avatar.jpg");
+await client.updateProfilePicture("./my-avatar.jpg");
 
 // From URL
-const result2 = await client.updateProfilePicture(
-  "https://example.com/avatar.jpg"
-);
+await client.updateProfilePicture("https://example.com/avatar.jpg");
 
 // From Buffer
 const imageBuffer = fs.readFileSync("./avatar.png");
-const result3 = await client.updateProfilePicture(imageBuffer);
+await client.updateProfilePicture(imageBuffer);
 
-if (result.success) {
-  console.log("Profile picture updated!");
-}
+// Remove profile picture
+await client.removeProfilePicture();
 ```
 
-### Remove Profile Picture
+### Update Profile Name
 
-Remove your profile picture:
+```typescript
+await client.updateProfileName("My Bot Name");
+```
+
+### Update Profile Status
 
 ```typescript
-const result = await client.removeProfilePicture();
+// Set status/about text
+await client.updateProfileStatus("Powered by Miaw Core");
 
-if (result.success) {
-  console.log("Profile picture removed");
-}
+// Clear status
+await client.updateProfileStatus("");
 ```
 
-### Update Profile Name
-
-Change your display name (push name):
+### Get Own Profile
 
 ```typescript
-const result = await client.updateProfileName("My Bot Name");
-
-if (result.success) {
-  console.log("Profile name updated!");
+const profile = await client.getOwnProfile();
+if (profile) {
+  console.log("JID:", profile.jid);
+  console.log("Phone:", profile.phone);
+  console.log("Name:", profile.name);
+  console.log("Status:", profile.status);
+  console.log("Picture:", profile.pictureUrl);
+  console.log("Is Business:", profile.isBusiness);
 }
 ```
 
-### Update Profile Status
+## UX & Presence
 
-Change your "About" text:
+### Read Receipts
 
 ```typescript
-const result = await client.updateProfileStatus("Powered by Miaw Core 🤖");
+client.on("message", async (msg) => {
+  // Mark message as read (send blue check marks)
+  await client.markAsRead(msg);
+});
+```
 
-if (result.success) {
-  console.log("Profile status updated!");
-}
+### Typing Indicators
 
-// Clear status
-await client.updateProfileStatus("");
-```
+```typescript
+// Show "typing..." indicator
+await client.sendTyping("6281234567890");
 
-### Profile Bot Example
+// Show "recording audio..." indicator
+await client.sendRecording("6281234567890");
+
+// Stop typing/recording indicator
+await client.stopTyping("6281234567890");
+```
 
-Bot that updates its profile based on commands:
+### Presence Status
 
 ```typescript
-client.on("message", async (msg) => {
-  if (msg.fromMe) return; // Ignore own messages
+// Set online status
+await client.setPresence("available");
 
-  const text = msg.text?.toLowerCase();
+// Set offline status
+await client.setPresence("unavailable");
+```
 
-  if (text === "!setstatus online") {
-    await client.updateProfileStatus("🟢 Online and ready to help!");
-    await client.sendText(msg.from, "Status updated to online!");
-  }
+### Subscribe to Presence Updates
 
-  if (text === "!setstatus busy") {
-    await client.updateProfileStatus("🔴 Busy - response may be delayed");
-    await client.sendText(msg.from, "Status updated to busy!");
+```typescript
+// Subscribe to contact's presence changes
+await client.subscribePresence("6281234567890");
+
+// Listen for presence updates
+client.on("presence", (update) => {
+  console.log(`${update.jid}: ${update.status}`);
+  // status: 'available' | 'unavailable' | 'composing' | 'recording' | 'paused'
+  if (update.lastSeen) {
+    console.log("Last seen:", new Date(update.lastSeen * 1000));
   }
 });
 ```
 
-## Business & Social Features (v0.9.0)
-
-This section covers WhatsApp Business features (labels, catalog/products) and social features (newsletters/channels, contacts).
+## Business Features
 
 > **Note:** Label and Catalog/Product features require a **WhatsApp Business account**.
 
-### Label Operations (WhatsApp Business Only)
-
-Labels help organize chats and messages. WhatsApp Business provides 20 label colors and 5 predefined labels.
-
-#### Create/Edit a Label
+### Labels (WhatsApp Business Only)
 
 ```typescript
 import { LabelColor } from "miaw-core";
 
+// Create a label
 const result = await client.addLabel({
-  id: "vip-customers",
   name: "VIP Customers",
   color: LabelColor.Color5,
 });
-
 if (result.success) {
   console.log("Label created:", result.labelId);
 }
-```
 
-#### Add Label to Chat
-
-```typescript
-const result = await client.addChatLabel("6281234567890", "label-id");
-
-if (result.success) {
-  console.log("Label added to chat");
-}
-```
-
-#### Remove Label from Chat
-
-```typescript
-const result = await client.removeChatLabel("6281234567890", "label-id");
-
-if (result.success) {
-  console.log("Label removed from chat");
-}
-```
+// Add label to a chat
+await client.addChatLabel("6281234567890", "label-id");
 
-#### Add/Remove Label from Message
+// Remove label from chat
+await client.removeChatLabel("6281234567890", "label-id");
 
-```typescript
-// Add label to message
+// Add label to a message
 await client.addMessageLabel("6281234567890", "message-id", "label-id");
 
 // Remove label from message
 await client.removeMessageLabel("6281234567890", "message-id", "label-id");
-```
 
-### Catalog/Product Operations (WhatsApp Business Only)
+// Fetch all labels
+const labels = await client.fetchAllLabels();
+if (labels.success) {
+  labels.labels?.forEach((label) => {
+    console.log(`${label.id}: ${label.name} (color: ${label.color})`);
+  });
+}
 
-Manage your product catalog and inventory.
+// Get chats with a specific label
+const chats = client.getChatsByLabel("label-id");
+chats.forEach((chat) => {
+  console.log("Chat:", chat.jid);
+});
+```
 
-#### Get Product Catalog
+### Catalog/Products (WhatsApp Business Only)
 
 ```typescript
+// Get your catalog
 const catalog = await client.getCatalog();
-
 if (catalog.success) {
   console.log("Products:", catalog.products);
   console.log("Next page cursor:", catalog.nextCursor);
 }
 
-// Get from another business
+// Get another business's catalog
 const otherCatalog = await client.getCatalog("6289876543210");
 
 // With pagination
 const paginated = await client.getCatalog(undefined, 20, catalog.nextCursor);
-```
-
-#### Get Product Collections
 
-```typescript
+// Get collections
 const collections = await client.getCollections();
-
 collections.forEach((col) => {
   console.log("Collection:", col.name);
   console.log("Products:", col.products);
 });
-```
-
-#### Create a Product
 
-```typescript
-const result = await client.createProduct({
+// Create a product
+const createResult = await client.createProduct({
   name: "Premium Widget",
   description: "High-quality widget for all your needs",
-  price: 1999, // In cents (e.g., $19.99)
+  price: 1999,
+  currency: "USD",
   imageUrls: ["https://example.com/product.jpg"],
-  isHidden: false,
   retailerId: "SKU-001",
   url: "https://example.com/product",
 });
-
-if (result.success) {
-  console.log("Product created:", result.productId);
+if (createResult.success) {
+  console.log("Product created:", createResult.productId);
 }
-```
-
-#### Update a Product
 
-```typescript
-const result = await client.updateProduct("product-id", {
+// Update a product
+await client.updateProduct("product-id", {
   name: "Premium Widget v2",
-  price: 2499, // $24.99
   description: "Updated with new features",
+  price: 2499,
+  currency: "USD",
 });
 
-if (result.success) {
-  console.log("Product updated:", result.productId);
-}
-```
-
-#### Delete Products
-
-```typescript
-const result = await client.deleteProducts(["product-id-1", "product-id-2"]);
-
-if (result.success) {
-  console.log("Deleted count:", result.deletedCount);
-}
+// Delete products
+await client.deleteProducts(["product-id-1", "product-id-2"]);
 ```
 
-### Newsletter/Channel Features
+## Newsletter/Channel Features
 
 WhatsApp Channels (newsletters) for broadcasting updates.
 
-> **Limitations:** WhatsApp does not provide APIs to list subscribed/owned newsletters or get channel member lists. Channels are one-way broadcasts - you can only get subscriber count.
-
-#### Create a Newsletter
+### Create Newsletter
 
 ```typescript
 const result = await client.createNewsletter(
@@ -737,45 +823,39 @@ const result = await client.createNewsletter(
 
 if (result.success) {
   console.log("Newsletter created:", result.newsletterId);
-  // Newsletter ID format: "1234567890@newsletter"
 }
 ```
 
-#### Send Message to Newsletter
+### Send to Newsletter
 
-You must be an admin/owner of the newsletter to send messages.
+> **Note:** You must be an admin/owner of the newsletter to send messages.
 
 ```typescript
-// Send text message
-const textResult = await client.sendNewsletterMessage(
+// Text message
+await client.sendNewsletterMessage(
   "1234567890@newsletter",
-  "Hello subscribers! Here's today's update..."
+  "Hello subscribers!"
 );
 
-if (textResult.success) {
-  console.log("Message sent:", textResult.messageId);
-}
-
-// Send image to newsletter
-const imageResult = await client.sendNewsletterImage(
+// Image
+await client.sendNewsletterImage(
   "1234567890@newsletter",
   "./announcement.jpg",
   "Check out our latest announcement!"
 );
 
-// Send video to newsletter
-const videoResult = await client.sendNewsletterVideo(
+// Video
+await client.sendNewsletterVideo(
   "1234567890@newsletter",
   "./update-video.mp4",
   "Watch our weekly update video"
 );
 ```
 
-#### Get Newsletter Metadata
+### Newsletter Metadata
 
 ```typescript
 const meta = await client.getNewsletterMetadata("1234567890@newsletter");
-
 if (meta) {
   console.log("Name:", meta.name);
   console.log("Description:", meta.description);
@@ -784,24 +864,21 @@ if (meta) {
 }
 ```
 
-#### Follow/Unfollow Newsletter
+### Follow/Unfollow Newsletter
 
 ```typescript
-// Follow
-const followed = await client.followNewsletter("1234567890@newsletter");
-
-// Unfollow
-const unfollowed = await client.unfollowNewsletter("1234567890@newsletter");
+await client.followNewsletter("1234567890@newsletter");
+await client.unfollowNewsletter("1234567890@newsletter");
 ```
 
-#### Mute/Unmute Newsletter
+### Mute/Unmute Newsletter
 
 ```typescript
 await client.muteNewsletter("1234567890@newsletter");
 await client.unmuteNewsletter("1234567890@newsletter");
 ```
 
-#### Update Newsletter
+### Update Newsletter
 
 ```typescript
 // Update name
@@ -820,7 +897,7 @@ await client.updateNewsletterPicture("1234567890@newsletter", "./cover.jpg");
 await client.removeNewsletterPicture("1234567890@newsletter");
 ```
 
-#### Fetch Newsletter Messages
+### Fetch Newsletter Messages
 
 ```typescript
 const messages = await client.fetchNewsletterMessages(
@@ -838,7 +915,7 @@ if (messages.success) {
 }
 ```
 
-#### React to Newsletter Message
+### React to Newsletter Message
 
 ```typescript
 // Add reaction
@@ -848,7 +925,7 @@ await client.reactToNewsletterMessage("1234567890@newsletter", "msg-id", "👍")
 await client.reactToNewsletterMessage("1234567890@newsletter", "msg-id", "");
 ```
 
-#### Newsletter Subscriber Info
+### Newsletter Administration
 
 ```typescript
 // Get subscriber count
@@ -856,19 +933,13 @@ const info = await client.getNewsletterSubscribers("1234567890@newsletter");
 console.log("Subscribers:", info?.subscribers);
 
 // Get admin count
-const adminCount = await client.getNewsletterAdminCount(
-  "1234567890@newsletter"
-);
+const adminCount = await client.getNewsletterAdminCount("1234567890@newsletter");
 console.log("Admins:", adminCount);
 
 // Subscribe to live updates
 await client.subscribeNewsletterUpdates("1234567890@newsletter");
-```
 
-#### Newsletter Admin Operations
-
-```typescript
-// Change owner
+// Transfer ownership
 await client.changeNewsletterOwner(
   "1234567890@newsletter",
   "new-owner@s.whatsapp.net"
@@ -884,120 +955,93 @@ await client.demoteNewsletterAdmin(
 await client.deleteNewsletter("1234567890@newsletter");
 ```
 
-### Contact Management
+## Data Retrieval
 
-Manage your WhatsApp contacts.
-
-#### Add or Edit Contact
+### Fetch All Contacts
 
 ```typescript
-const result = await client.addOrEditContact({
-  phone: "6281234567890",
-  name: "John Doe",
-  firstName: "John",
-  lastName: "Doe",
-});
-
+const result = await client.fetchAllContacts();
 if (result.success) {
-  console.log("Contact saved!");
+  console.log(`Found ${result.contacts?.length} contacts`);
+  result.contacts?.forEach((contact) => {
+    console.log(`${contact.name || "Unknown"}: ${contact.phone}`);
+  });
 }
 ```
 
-#### Remove Contact
+### Fetch All Groups
 
 ```typescript
-const result = await client.removeContact("6281234567890");
-
+const result = await client.fetchAllGroups();
 if (result.success) {
-  console.log("Contact removed!");
+  console.log(`Found ${result.groups?.length} groups`);
+  result.groups?.forEach((group) => {
+    console.log(`${group.name}: ${group.participantCount} members`);
+  });
 }
 ```
 
-### Business Bot Example
-
-Bot that manages labels and products:
+### Fetch All Chats
 
 ```typescript
-client.on("message", async (msg) => {
-  if (msg.fromMe) return;
-
-  const text = msg.text?.toLowerCase();
-
-  // Label management
-  if (text === "!label vip") {
-    const result = await client.addChatLabel(msg.from, "vip-label-id");
-    if (result.success) {
-      await client.sendText(msg.from, "You've been marked as VIP! ⭐");
-    }
-  }
+const result = await client.fetchAllChats();
+if (result.success) {
+  console.log(`Found ${result.chats?.length} chats`);
+  result.chats?.forEach((chat) => {
+    console.log(`${chat.name || chat.jid}: ${chat.unreadCount || 0} unread`);
+  });
+}
+```
 
-  // Catalog query
-  if (text === "!products") {
-    const catalog = await client.getCatalog();
-    if (catalog.success && catalog.products) {
-      let response = "Our products:\n\n";
-      catalog.products.forEach((p) => {
-        response += `${p.name}: $${(p.priceAmount1000! / 100).toFixed(2)}\n`;
-      });
-      await client.sendText(msg.from, response);
-    }
-  }
+### Get Chat Messages
 
-  // Create product (admin only)
-  if (text.startsWith("!addproduct")) {
-    const args = text.split(" ");
-    // Format: !addproduct <name> <price>
-    const name = args.slice(1, -1).join(" ");
-    const price = parseInt(args[args.length - 1]) * 100; // Convert to cents
+```typescript
+// Get messages for a specific chat
+const result = await client.getChatMessages("6281234567890");
+if (result.success) {
+  console.log(`Found ${result.messages?.length} messages`);
+  result.messages?.forEach((msg) => {
+    console.log(`[${msg.timestamp}] ${msg.text}`);
+  });
+}
 
-    const result = await client.createProduct({
-      name,
-      price,
-    });
+// Load older messages (pagination)
+const moreResult = await client.loadMoreMessages(
+  "6281234567890",
+  50, // count (max 50)
+  30000 // timeout in ms
+);
+if (moreResult.success) {
+  console.log(`Loaded ${moreResult.messagesLoaded} more messages`);
+  console.log("Has more:", moreResult.hasMore);
+}
 
-    if (result.success) {
-      await client.sendText(msg.from, `Product created: ${result.productId}`);
-    }
-  }
+// Get message counts for all chats
+const counts = client.getMessageCounts();
+counts.forEach((count, jid) => {
+  console.log(`${jid}: ${count} messages`);
 });
 ```
 
-### Newsletter Bot Example
-
-Bot that manages a newsletter:
+### Fetch All Labels
 
 ```typescript
-let newsletterId: string | null = null;
-
-// Create newsletter on startup
-client.on("ready", async () => {
-  const result = await client.createNewsletter(
-    "My Daily Updates",
-    "Daily news and updates"
-  );
-  if (result.success) {
-    newsletterId = result.newsletterId || null;
-    console.log("Newsletter created:", newsletterId);
-  }
-});
-
-// Post to newsletter from command
-client.on("message", async (msg) => {
-  if (msg.fromMe || !newsletterId) return;
-
-  const text = msg.text?.toLowerCase();
-
-  if (text.startsWith("!broadcast ")) {
-    const broadcastText = msg.text?.slice(11); // Remove "!broadcast "
-    await client.sendText(`${newsletterId}`, broadcastText);
-    await client.sendText(msg.from, "Broadcast sent to newsletter!");
-  }
+// Fetch labels (with optional force sync)
+const result = await client.fetchAllLabels(
+  false, // forceSync
+  2000 // syncTimeout
+);
+if (result.success) {
+  result.labels?.forEach((label) => {
+    console.log(`${label.name} (${label.id})`);
+  });
+}
 
-  if (text === "!stats") {
-    const info = await client.getNewsletterSubscribers(newsletterId);
-    await client.sendText(msg.from, `Subscribers: ${info?.subscribers}`);
-  }
-});
+// Debug label sync issues
+const info = client.getLabelsStoreInfo();
+console.log("Labels in store:", info.size);
+console.log("Label events received:", info.eventCount);
+console.log("Last sync:", info.lastSyncTime);
 ```
 
 ## Receiving Messages
@@ -1014,30 +1058,70 @@ client.on("message", (message) => {
   console.log("Is Group:", message.isGroup);
   console.log("Timestamp:", message.timestamp);
   console.log("From Me:", message.fromMe);
+  console.log("Sender Name:", message.senderName);
+  console.log("Sender Phone:", message.senderPhone);
 });
 ```
 
 ### Message Structure
 
-The `MiawMessage` object contains:
-
 ```typescript
 interface MiawMessage {
   id: string; // Unique message ID
-  from: string; // Sender WhatsApp ID (JID)
+  from: string; // Sender WhatsApp JID
+  senderPhone?: string; // Sender's phone number
+  senderName?: string; // Sender's display name
   text?: string; // Message text content
   timestamp: number; // Unix timestamp (seconds)
   isGroup: boolean; // Whether from group chat
   participant?: string; // Group participant ID (if isGroup)
   fromMe: boolean; // Whether sent by bot
-  type: string; // Message type: 'text' | 'image' | 'video' | etc.
+  type: "text" | "image" | "video" | "audio" | "document" | "sticker" | "unknown";
+  media?: MediaInfo; // Media metadata
   raw?: any; // Original Baileys message
 }
+
+interface MediaInfo {
+  mimetype?: string;
+  fileSize?: number;
+  fileName?: string;
+  width?: number;
+  height?: number;
+  duration?: number;
+  ptt?: boolean;
+  gifPlayback?: boolean;
+  viewOnce?: boolean;
+}
 ```
 
-### Filter Messages
+### Message Events
+
+```typescript
+// New message
+client.on("message", (msg) => {
+  console.log("New message:", msg.text);
+});
 
-Common filtering patterns:
+// Message edited
+client.on("message_edit", (edit) => {
+  console.log(`Message ${edit.messageId} edited to: ${edit.newText}`);
+  console.log("Edit timestamp:", edit.editTimestamp);
+});
+
+// Message deleted
+client.on("message_delete", (deletion) => {
+  console.log(`Message ${deletion.messageId} deleted`);
+  console.log("Deleted by sender:", deletion.fromMe);
+});
+
+// Reaction received
+client.on("message_reaction", (reaction) => {
+  console.log(`${reaction.reactorId} reacted with ${reaction.emoji}`);
+  console.log("Is removal:", reaction.isRemoval);
+});
+```
+
+### Filter Messages
 
 ```typescript
 client.on("message", async (msg) => {
@@ -1058,61 +1142,26 @@ client.on("message", async (msg) => {
 });
 ```
 
-### Echo Bot Example
-
-Simple bot that echoes messages:
-
-```typescript
-client.on("message", async (msg) => {
-  if (msg.fromMe || !msg.text) return;
-
-  await client.sendText(msg.from, `Echo: ${msg.text}`);
-});
-```
-
-### Command Handler Example
-
-Bot with command handling:
-
-```typescript
-client.on("message", async (msg) => {
-  if (msg.fromMe || !msg.text) return;
-
-  const text = msg.text.toLowerCase();
-
-  if (text === "/help") {
-    await client.sendText(
-      msg.from,
-      "Available commands:\n" +
-        "/help - Show this message\n" +
-        "/ping - Test bot response\n" +
-        "/time - Get current time"
-    );
-  } else if (text === "/ping") {
-    await client.sendText(msg.from, "Pong! 🏓");
-  } else if (text === "/time") {
-    const time = new Date().toLocaleString();
-    await client.sendText(msg.from, `Current time: ${time}`);
-  }
-});
-```
-
 ## Connection Management
 
 ### Connect
 
-Start the WhatsApp connection:
-
 ```typescript
 await client.connect();
 ```
 
-### Disconnect
-
-Stop the connection and logout:
+### Disconnect (Preserve Session)
 
 ```typescript
 await client.disconnect();
+// Session preserved, can reconnect without QR
+```
+
+### Logout (Clear Session)
+
+```typescript
+await client.logout();
+// Session cleared, next connect() requires new QR
 ```
 
 ### Check Connection State
@@ -1126,12 +1175,13 @@ const state = client.getConnectionState();
 if (client.isConnected()) {
   console.log("Ready to send messages");
 }
+
+// Get instance ID
+console.log("Instance:", client.getInstanceId());
 ```
 
 ### Connection Events
 
-Monitor connection status:
-
 ```typescript
 client.on("connection", (state) => {
   console.log("Connection state:", state);
@@ -1150,22 +1200,11 @@ client.on("reconnecting", (attempt) => {
 });
 ```
 
-### Auto-Reconnection
-
-Miaw Core automatically handles reconnection:
+### Dispose Client
 
 ```typescript
-const client = new MiawClient({
-  instanceId: "bot",
-  autoReconnect: true, // Enable auto-reconnect
-  maxReconnectAttempts: 10, // Try 10 times
-  reconnectDelay: 5000, // Wait 5s between attempts
-});
-
-// Connection drops are handled automatically
-client.on("reconnecting", (attempt) => {
-  console.log(`Reconnection attempt ${attempt}`);
-});
+// Clean up all resources
+await client.dispose();
 ```
 
 ## Multiple Instances
@@ -1173,9 +1212,6 @@ client.on("reconnecting", (attempt) => {
 Run multiple WhatsApp connections in the same process:
 
 ```typescript
-import { MiawClient } from "miaw-core";
-
-// Create multiple instances
 const bot1 = new MiawClient({
   instanceId: "customer-support",
 });
@@ -1184,45 +1220,34 @@ const bot2 = new MiawClient({
   instanceId: "sales-bot",
 });
 
-const bot3 = new MiawClient({
-  instanceId: "notifications",
-});
-
 // Each has separate QR code and session
 bot1.on("qr", (qr) => console.log("Bot 1 QR:", qr));
 bot2.on("qr", (qr) => console.log("Bot 2 QR:", qr));
-bot3.on("qr", (qr) => console.log("Bot 3 QR:", qr));
 
 // Start all instances
-await Promise.all([bot1.connect(), bot2.connect(), bot3.connect()]);
+await Promise.all([bot1.connect(), bot2.connect()]);
 
 // Each operates independently
-bot1.on("message", (msg) => {
-  console.log("Bot 1 received:", msg.text);
-});
-
-bot2.on("message", (msg) => {
-  console.log("Bot 2 received:", msg.text);
-});
+bot1.on("message", (msg) => console.log("Bot 1:", msg.text));
+bot2.on("message", (msg) => console.log("Bot 2:", msg.text));
 ```
 
 ## Session Management
 
 ### Session Storage Location
 
-Sessions are stored in the filesystem:
-
-```
+```plaintext
 sessions/
   ├── bot-1/
   │   ├── creds.json
+  │   ├── contacts.json
+  │   ├── chats.json
+  │   ├── messages.json
+  │   ├── labels.json
+  │   ├── lid-mappings.json
   │   └── app-state-sync-*.json
-  ├── bot-2/
-  │   ├── creds.json
-  │   └── app-state-sync-*.json
-  └── bot-3/
-      ├── creds.json
-      └── app-state-sync-*.json
+  └── bot-2/
+      └── ...
 ```
 
 ### Custom Session Path
@@ -1232,110 +1257,41 @@ const client = new MiawClient({
   instanceId: "my-bot",
   sessionPath: "/var/lib/whatsapp/sessions",
 });
-// Session will be stored in: /var/lib/whatsapp/sessions/my-bot/
-```
-
-### Session Persistence
-
-Sessions persist across restarts:
-
-```typescript
-// First run
-const client = new MiawClient({ instanceId: "bot" });
-await client.connect(); // QR code required
-// Session saved automatically
-
-// Next run (restart app)
-const client = new MiawClient({ instanceId: "bot" });
-await client.connect(); // No QR code! Uses saved session
-```
-
-### Clear Session (Logout)
-
-To logout and start fresh:
-
-```bash
-# Manual deletion
-rm -rf ./sessions/my-bot/
-
-# Or programmatically
-import { rmSync } from 'fs';
-rmSync('./sessions/my-bot', { recursive: true, force: true });
+// Session: /var/lib/whatsapp/sessions/my-bot/
 ```
 
 ## Event Reference
 
 ### Available Events
 
-| Event           | Parameters                 | Description                 |
-| --------------- | -------------------------- | --------------------------- |
-| `qr`            | `(qrCode: string)`         | QR code needs to be scanned |
-| `ready`         | `()`                       | Client connected and ready  |
-| `message`       | `(message: MiawMessage)`   | New message received        |
-| `connection`    | `(state: ConnectionState)` | Connection state changed    |
-| `disconnected`  | `(reason?: string)`        | Client disconnected         |
-| `reconnecting`  | `(attempt: number)`        | Attempting to reconnect     |
-| `error`         | `(error: Error)`           | Error occurred              |
-| `session_saved` | `()`                       | Session credentials saved   |
-
-### Event Examples
-
-```typescript
-// QR Code
-client.on("qr", (qr) => {
-  console.log("Scan this:", qr);
-});
-
-// Ready
-client.on("ready", () => {
-  console.log("Connected!");
-});
-
-// Message
-client.on("message", (msg) => {
-  console.log("New message:", msg.text);
-});
-
-// Connection State
-client.on("connection", (state) => {
-  console.log("State:", state);
-});
-
-// Disconnected
-client.on("disconnected", (reason) => {
-  console.log("Lost connection:", reason);
-});
-
-// Reconnecting
-client.on("reconnecting", (attempt) => {
-  console.log(`Reconnect attempt #${attempt}`);
-});
-
-// Error
-client.on("error", (error) => {
-  console.error("Error:", error.message);
-});
-
-// Session Saved
-client.on("session_saved", () => {
-  console.log("Session persisted");
-});
-```
+| Event             | Parameters                 | Description                          |
+| ----------------- | -------------------------- | ------------------------------------ |
+| `qr`              | `(qrCode: string)`         | QR code needs to be scanned          |
+| `ready`           | `()`                       | Client connected and ready           |
+| `message`         | `(message: MiawMessage)`   | New message received                 |
+| `message_edit`    | `(edit: MessageEdit)`      | Message was edited                   |
+| `message_delete`  | `(deletion: MessageDelete)`| Message was deleted                  |
+| `message_reaction`| `(reaction: MessageReaction)` | Message received reaction         |
+| `presence`        | `(update: PresenceUpdate)` | Contact's presence changed           |
+| `connection`      | `(state: ConnectionState)` | Connection state changed             |
+| `disconnected`    | `(reason?: string)`        | Client disconnected                  |
+| `reconnecting`    | `(attempt: number)`        | Attempting to reconnect              |
+| `error`           | `(error: Error)`           | Error occurred                       |
+| `session_saved`   | `()`                       | Session credentials saved            |
 
 ## Error Handling
 
-### Send Message Errors
+### Result Objects
+
+Most methods return result objects:
 
 ```typescript
 const result = await client.sendText("1234567890", "Hello");
 
-if (!result.success) {
-  console.error("Failed to send:", result.error);
-
-  // Handle specific errors
-  if (result.error?.includes("not connected")) {
-    console.log("Wait for connection...");
-  }
+if (result.success) {
+  console.log("Sent:", result.messageId);
+} else {
+  console.error("Failed:", result.error);
 }
 ```
 
@@ -1344,21 +1300,6 @@ if (!result.success) {
 ```typescript
 client.on("error", (error) => {
   console.error("Client error:", error.message);
-
-  // Log to monitoring service
-  // Send alert
-  // etc.
-});
-```
-
-### Connection Errors
-
-```typescript
-client.on("disconnected", (reason) => {
-  if (reason === "loggedOut") {
-    console.log("Need to re-authenticate");
-    // Delete session and restart
-  }
 });
 ```
 
@@ -1369,7 +1310,6 @@ try {
   await client.connect();
 } catch (error) {
   console.error("Failed to connect:", error);
-  // Handle startup errors
 }
 ```
 
@@ -1377,8 +1317,6 @@ try {
 
 Miaw Core is written in TypeScript with full type definitions:
 
-### Import Types
-
 ```typescript
 import {
   MiawClient,
@@ -1386,63 +1324,97 @@ import {
   MiawClientOptions,
   ConnectionState,
   SendMessageResult,
+  SendTextOptions,
+  SendImageOptions,
+  SendVideoOptions,
+  SendAudioOptions,
+  SendDocumentOptions,
+  MediaSource,
+  ContactInfo,
+  ContactProfile,
+  BusinessProfile,
+  GroupInfo,
+  GroupParticipant,
+  Label,
+  LabelColor,
+  Product,
+  ProductOptions,
+  NewsletterMetadata,
+  MessageEdit,
+  MessageDelete,
+  MessageReaction,
+  PresenceUpdate,
 } from "miaw-core";
 ```
 
-### Type-Safe Configuration
+## LID Privacy Support
+
+WhatsApp introduced Link IDs (LIDs) for enhanced privacy. Miaw Core automatically handles LID to phone number resolution:
 
 ```typescript
-const options: MiawClientOptions = {
-  instanceId: "bot",
-  sessionPath: "./sessions",
-  debug: true,
-  autoReconnect: true,
-  maxReconnectAttempts: 10,
-  reconnectDelay: 5000,
-};
+// Messages may come from @lid JIDs
+client.on("message", (msg) => {
+  // msg.from could be "123456@lid" or "6281234567890@s.whatsapp.net"
+  // msg.senderPhone will be resolved if possible
+  console.log("Sender phone:", msg.senderPhone);
+});
 
-const client = new MiawClient(options);
-```
+// Manual LID resolution
+const phoneJid = client.resolveLidToJid("123456@lid");
+const phone = client.getPhoneFromJid("123456@lid");
 
-### Type-Safe Event Handlers
+// Register LID mapping (useful for persistence)
+client.registerLidMapping("123456@lid", "6281234567890@s.whatsapp.net");
 
-```typescript
-client.on("message", (msg: MiawMessage) => {
-  // TypeScript knows the structure
-  console.log(msg.text); // string | undefined
-  console.log(msg.timestamp); // number
-  console.log(msg.isGroup); // boolean
-});
+// Get all mappings
+const mappings = client.getLidMappings();
 
-client.on("connection", (state: ConnectionState) => {
-  // 'disconnected' | 'connecting' | 'connected' | 'reconnecting' | 'qr_required'
-  if (state === "connected") {
-    console.log("Ready!");
-  }
-});
+// Clear LID cache
+client.clearLidCache();
 ```
 
-### Type-Safe Result Handling
+## Debugging
+
+### Enable Debug Mode
 
 ```typescript
-const result: SendMessageResult = await client.sendText("...", "Hello");
+// At creation
+const client = new MiawClient({
+  instanceId: "my-bot",
+  debug: true,
+});
 
-if (result.success) {
-  // TypeScript knows messageId exists here
-  console.log(result.messageId);
-} else {
-  // TypeScript knows error exists here
-  console.error(result.error);
+// At runtime
+client.enableDebug();
+client.disableDebug();
+
+// Toggle
+client.setDebug(true);
+client.setDebug(false);
+
+// Check status
+if (client.isDebugEnabled()) {
+  console.log("Debug mode is on");
 }
 ```
 
+Debug mode enables verbose logging including:
+
+- Raw Baileys message structures
+- History sync notifications
+- LID mapping updates
+- Store updates (contacts, chats, messages)
+- Label sync events
+
+---
+
 ## Complete Example
 
-For a full-featured bot demonstrating all current capabilities, see:
+For full-featured bot examples demonstrating all capabilities, see:
 
-**[examples/simple-bot.ts](./examples/simple-bot.ts)**
+- **[examples/simple-bot.ts](../examples/simple-bot.ts)** - Basic bot example
 
-The example includes:
+The examples include:
 
 - QR code authentication handling
 - Message receiving and command processing