@moveo-ai/web-client 0.86.2 → 0.87.0-true.2

package/README.md

@@ -10,11 +10,26 @@
 
 ## 📦 Getting Started
 
+### Chat Widget Integration
+
 1. Create an account on https://console.moveo.ai
-1. Create an environment
-1. Create a web integration
-1. Copy the snippet to your website html
-1. Enjoy 🚀
+2. Create an environment
+3. Create a web integration
+4. Copy the snippet to your website html
+5. Enjoy 🚀
+
+### Audio Widget Integration
+
+Add voice calling capabilities to your website:
+
+```html
+<script src="https://cdn.moveo.ai/audio-client.min.js"></script>
+<script>
+  window.addEventListener('load', async function () {
+    const controller = await MoveoAudio.init({ integrationId: 'YOUR_INTEGRATION_ID' });
+  });
+</script>
+```
 
 ## 🛠 Development
 
@@ -35,9 +50,11 @@ npm install
 The web-client can be run in different modes depending on your development needs:
 
 #### Development Mode
+
 ```bash
 npm start
 ```
+
 This starts the webpack dev server on https://localhost:8880 with hot module replacement enabled.
 
 #### Local Testing with Different Environments
@@ -49,6 +66,7 @@ When running locally, you can specify which Moveo Channels backend to connect to
 - **Custom Backend**: Add `?host=YOUR_BACKEND_URL` to test against different environments
 
 Example URLs:
+
 ```
 https://localhost:8880/?integration_id=YOUR_ID&host=https://channels.moveo.ai  # Production
 https://localhost:8880/?integration_id=YOUR_ID&host=https://dev-channels.moveo.ai  # Dev
@@ -68,6 +86,55 @@ npm run build:dev
 npm run watch
 ```
 
+### 📦 Library Exports
+
+The build process generates multiple UMD libraries for different use cases:
+
+#### Chat Widget (`MoveoAI`)
+
+- **`web-client.min.js`** (40KB) - Loader script for the chat widget
+- **`iframe.v2.min.js`** (1.3MB) - Chat widget iframe (v2, current)
+- **`iframe.min.js`** (1.2MB) - Chat widget iframe (v1, deprecated)
+
+**Usage**:
+
+```html
+<script src="https://cdn.moveo.ai/web-client.min.js"></script>
+<script>
+  MoveoAI.init({ integrationId: 'your-id' });
+</script>
+```
+
+#### Audio Widget (`MoveoAudio`)
+
+- **`audio-client.min.js`** (341KB) - Voice widget with Twilio integration
+
+**Usage**:
+
+```html
+<script src="https://cdn.moveo.ai/audio-client.min.js"></script>
+<script>
+  const controller = await MoveoAudio.init({ integrationId: 'your-id' });
+</script>
+```
+
+**Module Bundler Usage** (webpack, vite, etc.):
+
+```typescript
+// Chat widget
+import MoveoAI from '@moveo-ai/web-client';
+MoveoAI.init({ integrationId: 'your-id' });
+
+// Audio widget
+import MoveoAudio, {
+  AudioController,
+  AudioConfig,
+} from '@moveo-ai/web-client/audio-client.min.js';
+const controller: AudioController = await MoveoAudio.init({
+  integrationId: 'your-id',
+});
+```
+
 ### Testing
 
 ```bash
@@ -115,6 +182,7 @@ npm run build-storybook
 ### Current: Cloudflare Pages
 
 The web-client is currently deployed to **Cloudflare Pages**, providing:
+
 - Global CDN distribution
 - Automatic deployments from GitHub
 - Preview deployments for pull requests
@@ -129,6 +197,7 @@ The project was originally deployed on Vercel but has been migrated to Cloudflar
 The production build is automatically deployed when changes are pushed to the `main` branch. Preview deployments are created for pull requests to the `next` branch.
 
 Build settings:
+
 - Build command: `npm run build`
 - Build output directory: `dist`
 - Node version: 16+