@robylon/web-react-sdk 1.1.26-staging.7 → 1.1.28-staging.0

package/README.md

@@ -1,154 +1,71 @@
-# Robylon Web React SDK
+# Robylon SDK
 
-A lightweight React SDK for integrating Robylon's AI-powered chatbot into your web applications.
+The Robylon SDK provides chatbot functionality that can be used in both React and vanilla JavaScript applications.
 
 ## Installation
 
+### React
+
 ```bash
 npm install @robylon/web-react-sdk
-# or
-yarn add @robylon/web-react-sdk
 ```
 
-## Quick Start
-
-```jsx
-import { Chatbot } from "@robylon/web-react-sdk";
-
-function App() {
-  const handleChatbotEvent = (event) => {
-    logger.log(`Chatbot event: ${event.type}`, event);
-  };
+### Vanilla JavaScript
 
-  return (
-    <Chatbot
-      api_key="your-api-key"
-      user_id="user-id"
-      user_token="optional-auth-token"
-      user_profile={{
-        email: "user@example.com",
-        name: "John Doe",
-        mobile: "1234567890",
-      }}
-      onEvent={handleChatbotEvent}
-    />
-  );
-}
+```html
+<script src="https://staging-cdn.robylon.com/sdk/1.1.27/robylon.min.js"></script>
 ```
 
-## Configuration
-
-### Required Props
+Or via npm:
 
-- `api_key`: Your Robylon API key
-- `user_id`: Unique identifier for the current user
-
-### Optional Props
-
-- `user_token`: Authentication token for the user
-- `user_profile`: Object containing user information
-  - `email`: User's email address
-  - `name`: User's name
-  - `mobile`: User's mobile number
-- `onEvent`: Callback function to handle chatbot events
-
-### Event Handling
-
-The SDK emits various events that you can listen to using the `onEvent` prop. Each event has the following structure:
-
-```typescript
-interface ChatbotEvent {
-  type: ChatbotEventType;
-  timestamp: number;
-  data?: any;
-}
+```bash
+npm install @robylon/web-react-sdk
 ```
 
-Available event types:
-
-```typescript
-enum ChatbotEventType {
-  CHATBOT_BUTTON_LOADED = "CHATBOT_BUTTON_LOADED", // When the chat button is rendered
-  CHATBOT_OPENED = "CHATBOT_OPENED", // When chat window is opened
-  CHATBOT_CLOSED = "CHATBOT_CLOSED", // When chat window is closed
-  CHATBOT_APP_READY = "CHATBOT_APP_READY", // When SDK is fully initialized
-  CHATBOT_LOADED = "CHATBOT_LOADED", // When chatbot iframe is loaded
-  CHAT_INITIALIZED = "CHAT_INITIALIZED", // When chat session is initialized
-  SESSION_REFRESHED = "SESSION_REFRESHED", // When chat session is refreshed
-  CHAT_INITIALIZATION_FAILED = "CHAT_INITIALIZATION_FAILED", // When initialization fails
-}
-```
+## Usage
 
-Example usage:
+### React
 
 ```jsx
-function App() {
-  const handleChatbotEvent = (event) => {
-    switch (event.type) {
-      case "CHATBOT_BUTTON_CLICKED":
-        logger.log("Chat button clicked at:", new Date(event.timestamp));
-        break;
-      case "CHATBOT_OPENED":
-        logger.log("Chat window opened at:", new Date(event.timestamp));
-        break;
-      case "CHAT_INITIALIZED":
-        logger.log("Chat session initialized");
-        break;
-      case "CHAT_INITIALIZATION_FAILED":
-        console.error("Chat initialization failed:", event.data);
-        break;
-    }
-  };
+import { Chatbot } from '@robylon/web-react-sdk/react';
 
+function App() {
   return (
-    <Chatbot
-      api_key="your-api-key"
-      user_id="user-id"
-      onEvent={handleChatbotEvent}
-    />
+    <div className="App">
+      <Chatbot 
+        api_key="your-api-key"
+        user_id="optional-user-id"
+        onEvent={(event) => console.log(event)}
+      />
+    </div>
   );
 }
 ```
 
-### Automatically Included Information
-
-The SDK automatically collects and includes the following system information:
-
-- `platform`: Always set to "web"
-- `os`: User's operating system
-- `browser`: User's browser type
-- `device`: Device type (desktop/mobile/tablet)
-- `screen_size`: User's screen dimensions (width and height)
-- `sdk_version`: Current version of the SDK
-
-## Features
-
-- Persistent chat interface
-- Responsive design for all screen sizes
-- Automatic system information collection
-- Customizable chat bubble
-- Session management
-- Secure communication channel
-- Cross-browser compatibility
-- Comprehensive event system
-
-## Browser Support
-
-The SDK supports all modern browsers and includes fallbacks for:
-
-- User agent detection
-- Screen size detection
-- Browser identification
-- Device type detection
-
-## Development
-
-### Creating Branches
-
-Always use the provided script to create new branches:
-
-```bash
-npm run branch
+### Vanilla JavaScript
+
+```javascript
+// From CDN
+Robylon.create({
+  api_key: 'your-api-key',
+  user_id: 'optional-user-id',
+  onEvent: (event) => console.log(event)
+}).then(chatbot => {
+  // The chatbot is now ready to use
+  chatbot.show();
+});
+
+// From npm module
+import { create } from '@robylon/web-react-sdk';
+
+create({
+  api_key: 'your-api-key',
+  user_id: 'optional-user-id'
+}).then(chatbot => {
+  chatbot.show();
+});
 ```
 
-This ensures proper version control and naming conventions.
+## Documentation
+
+For detailed documentation, please visit: [https://app.robylon.ai/docs](https://app.robylon.ai/docs)