@floe-ai/sdk 0.1.0-dev.2

package/LICENSE

@@ -0,0 +1,36 @@
+Copyright © 2026 Floe AI, Inc. All rights reserved.
+
+PROPRIETARY SOFTWARE LICENSE
+
+This software and associated documentation files (the "Software") are the 
+proprietary and confidential property of Floe AI, Inc.
+
+RESTRICTIONS:
+
+1. You may not copy, modify, distribute, sell, or transfer the Software or 
+   any portion thereof without prior written permission from Floe AI, Inc.
+
+2. You may not reverse engineer, decompile, or disassemble the Software.
+
+3. You may not use the Software for any purpose other than as expressly 
+   authorized by Floe AI, Inc.
+
+4. You may not remove or alter any proprietary notices, labels, or marks 
+   on the Software.
+
+USAGE:
+
+Use of this Software requires a valid license agreement with Floe AI, Inc.
+Contact sales@floe.so for licensing information.
+
+DISCLAIMER:
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+FLOE AI, INC. BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+For licensing inquiries, contact: legal@floe.so
+

package/README.md

@@ -0,0 +1,144 @@
+# @floe-ai/sdk
+
+AI-powered onboarding SDK for React applications. Add voice-guided product tours and interactive onboarding to your app with a single function call.
+
+## Installation
+
+```bash
+npm install @floe-ai/sdk
+```
+
+## Quick Start
+
+```typescript
+import { Floe } from '@floe-ai/sdk';
+
+// Initialize the SDK
+const sdk = Floe({
+  clientKey: 'your-client-key',
+  userInfo: {
+    externalId: 'user_123',
+    email: 'user@example.com',
+    name: 'John Doe',
+  },
+});
+
+// The SDK automatically initializes and renders the onboarding UI
+```
+
+## Configuration Options
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `clientKey` | `string` | ✅ | Your Floe API client key |
+| `apiUrl` | `string` | | Floe API URL (defaults to production) |
+| `enableScreenCapture` | `boolean` | | Enable screen sharing (default: `true`) |
+| `enableAudio` | `boolean` | | Enable voice interaction (default: `true`) |
+| `debug` | `boolean` | | Enable debug logging |
+| `skipOnboardingModal` | `boolean` | | Skip the welcome modal for returning users |
+| `userInfo` | `object` | | User identification for personalization |
+| `industry` | `string` | | User's industry for context |
+| `useCase` | `string` | | User's use case |
+| `companyName` | `string` | | User's company name |
+| `companySize` | `string` | | Company size |
+| `role` | `string` | | User's role |
+
+### User Info
+
+```typescript
+userInfo: {
+  externalId?: string;    // Your internal user ID
+  email?: string;         // User's email
+  name?: string;          // Display name
+  company?: string;       // Company name
+  designation?: string;   // Job title
+  metadata?: Record<string, any>;  // Custom metadata
+}
+```
+
+## Methods
+
+The `Floe()` function returns an SDK instance with the following methods:
+
+```typescript
+const sdk = Floe({ clientKey: 'your-key' });
+
+// Disconnect and cleanup
+await sdk.disconnect();
+
+// Get connection status
+const status = sdk.getStatus();
+// { initialized: boolean, connected: boolean, sessionId: string, microphoneMuted: boolean }
+
+// Toggle microphone
+sdk.toggleMute();
+
+// Send text message to the AI
+await sdk.sendText('How do I create a new project?');
+
+// Take a screenshot
+const screenshot = await sdk.takeScreenshot();
+
+// Highlight an element
+sdk.highlight('.my-button');
+sdk.clearHighlight();
+```
+
+## CDN Usage
+
+For non-React applications or script tag usage:
+
+```html
+<script src="https://cdn.floe.so/sdk/floe-sdk.iife.js"></script>
+<script>
+  Floe({
+    clientKey: 'your-client-key',
+    userInfo: {
+      externalId: 'user_123',
+    },
+  });
+</script>
+```
+
+## TypeScript Support
+
+Full TypeScript support with exported types:
+
+```typescript
+import { Floe, FloeConfig } from '@floe-ai/sdk';
+
+const config: FloeConfig = {
+  clientKey: 'your-key',
+  debug: true,
+};
+
+const sdk = Floe(config);
+```
+
+## Requirements
+
+- React 18+
+- Modern browser with WebRTC support
+
+## Peer Dependencies
+
+```json
+{
+  "react": "^18.0.0",
+  "react-dom": "^18.0.0"
+}
+```
+
+## License
+
+Copyright © 2026 Floe AI, Inc. All rights reserved.
+
+This software is proprietary and confidential. Unauthorized copying, distribution, 
+or use of this software, via any medium, is strictly prohibited without prior 
+written permission from Floe AI, Inc.
+
+## Support
+
+- Documentation: https://docs.floe.so
+- Email: support@floe.so
+