vibrium-speak-sdk 1.0.0

package/README.md

@@ -0,0 +1,166 @@
+# Vibrium Voice LiveKit SDK
+
+A dead simple React SDK for adding voice capabilities to your website via LiveKit.
+
+**🎯 Goal**: Drop-in mic button → Click → Connects to Lambda → Gets LiveKit token → Voice conversation starts
+
+## Features
+
+✨ **Super Simple Integration** - Just one component: `<FloatingMic />`  
+🎤 **Floating Mic Button** - Appears at bottom-right of screen  
+🔊 **Automatic Audio Handling** - WebRTC audio to LiveKit server  
+💬 **Message History** - Shows conversation in side panel  
+🔇 **Mic/Speaker Controls** - Mute individual tracks  
+👥 **Participant List** - See who's connected  
+🎯 **TypeScript Support** - Full type definitions  
+⚡ **Token Caching** - 1-hour cache to avoid Lambda calls  
+
+## Quick Start
+
+### 1. Install
+
+```bash
+npm install vibrium-voice-sdk
+```
+
+### 2. Add to Your App
+
+```jsx
+import { FloatingMic } from 'vibrium-voice-sdk';
+
+export default function App() {
+  return (
+    <>
+      <h1>Welcome to My Site</h1>
+      {/* That's it! Mic appears at bottom-right */}
+      <FloatingMic lambdaUrl="https://your-lambda.com/session" />
+    </>
+  );
+}
+```
+
+### 3. Create Lambda Endpoint
+
+Your Lambda should return:
+
+```json
+{
+  "token": "eyJhbGc...",
+  "url": "wss://livekit-server.com",
+  "room": "room-name",
+  "displayName": "User Name"
+}
+```
+
+**Example Lambda (Node.js):**
+
+```javascript
+import { AccessToken } from 'livekit-server-sdk';
+
+export const handler = async (event) => {
+  const token = new AccessToken(
+    process.env.LIVEKIT_API_KEY,
+    process.env.LIVEKIT_API_SECRET
+  );
+  
+  token.addGrant({
+    room: 'my-room',
+    roomJoin: true,
+    canPublish: true,
+    canSubscribe: true,
+  });
+
+  return {
+    statusCode: 200,
+    body: JSON.stringify({
+      token: token.toJwt(),
+      url: process.env.LIVEKIT_URL,
+      room: 'my-room',
+      displayName: 'User',
+    }),
+  };
+};
+```
+
+## Documentation
+
+- **[Integration Guide](./INTEGRATION_GUIDE.md)** - Complete integration docs
+- **[Examples](./EXAMPLES.md)** - Code examples for different use cases
+- **[API Reference](./INTEGRATION_GUIDE.md#api-reference)** - All hooks and types
+
+## Usage Examples
+
+### Simple (Recommended)
+```jsx
+<FloatingMic lambdaUrl="https://your-lambda.com/session" />
+```
+
+### With Configuration
+```jsx
+<FloatingMic
+  lambdaUrl="https://api.example.com/session"
+  lambdaPayload={{ userId: '123', context: 'support' }}
+  textEnabled={true}
+  displayName="John Doe"
+/>
+```
+
+### Advanced with Hook
+```jsx
+import { useLiveKitRoom } from 'vibrium-voice-sdk';
+
+function MyComponent() {
+  const livekit = useLiveKitRoom();
+
+  return (
+    <div>
+      <button onClick={() => livekit.connect(config)}>
+        Connect
+      </button>
+      <p>{livekit.state}</p>
+      {livekit.messages.map(m => <div key={m}>{m.text}</div>)}
+    </div>
+  );
+}
+```
+
+## Props
+
+### FloatingMic
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `lambdaUrl` | string | Your Lambda endpoint (required) |
+| `lambdaPayload` | object | Extra data to send to Lambda |
+| `displayName` | string | Display name for participant |
+| `textEnabled` | boolean | Show text input field |
+
+## Browser Support
+
+- Chrome/Edge 90+
+- Firefox 88+
+- Safari 14+
+
+## Development
+
+### Setup
+
+```bash
+npm install
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Pack for NPM
+
+```bash
+npm pack
+```
+
+## License
+
+MIT