obi-sdk 0.1.1 → 0.1.2

package/README.md

@@ -30,7 +30,7 @@ The loader accepts the following configuration options:
 
 The simplest way to add Obi to your website is by using the inline loader script:
 
-1. Copy the full inline loader script from above
+1. Copy the full inline loader script from below
 2. Add it to your HTML page
 3. Configure the widget using `window.obiWidgetConfig`
 
@@ -126,10 +126,10 @@ The simplest way to add Obi to your website is by using the inline loader script
           var s = d.createElement("script")
           s.type = "text/javascript"
           s.async = !0
-          var b = "https://cdn.iamobi.ai/obi-sdk"
+          var b = "https://unpkg.com/obi-sdk"
           s.src = f.noCacheSDK
-            ? b + "-" + f.sdkVersion + ".js?t=" + Date.now()
-            : b + "-" + f.sdkVersion + ".js"
+            ? b + "@" + f.sdkVersion + "/dist/obi-sdk.standalone.iife.js?t=" + Date.now()
+            : b + "@" + f.sdkVersion + "/dist/obi-sdk.standalone.iife.js"
           s.onload = cb
           s.onerror = function () {
             w.__obiSDKLoading = !1
@@ -197,6 +197,54 @@ The simplest way to add Obi to your website is by using the inline loader script
 
 The widget will automatically appear in the specified position on your page.
 
+## How It Works
+
+The loader script:
+
+1. Dynamically checks for the latest version using the npm registry API
+2. Loads the Obi SDK from unpkg.com with the appropriate version
+3. Creates and positions the `<obi-widget>` custom element on your page
+4. Initializes the widget with your API key and configuration
+
+## Installation for npm Projects
+
+You can also install the SDK via npm:
+
+```bash
+npm install obi-sdk
+```
+
+And import it in your application:
+
+```javascript
+import ObiSDK from "obi-sdk"
+
+// Initialize the SDK
+const sdk = new ObiSDK({
+  apiKey: "YOUR_API_KEY",
+  apiBaseUrl: "https://www.iamobi.ai/api/",
+})
+```
+
+## Building the SDK
+
+To build the SDK locally:
+
+```bash
+# Install dependencies
+npm install
+
+# Build all formats (UMD, ES, standalone IIFE, and loader)
+npm run build:all
+```
+
+This generates the following in the `dist` directory:
+
+- `obi-sdk.umd.js` - UMD format for CommonJS/AMD environments
+- `obi-sdk.es.js` - ES Module format for modern bundlers
+- `obi-sdk.standalone.iife.js` - IIFE format with all dependencies bundled
+- `obi-loader.iife.js` - Standalone loader script
+
 ## Coming Soon
 
 The following features are under development and will be available in future releases:
@@ -218,14 +266,14 @@ The inline loader script provides a self-contained way to add the Obi Widget to
 5. It creates the `<obi-widget>` element and positions it on the page
 6. It configures the widget with the provided options
 
-Before using in production, you should update the CDN URL to point to where you host the SDK files:
+Before using in production, you can use unpkg.com as a CDN which automatically serves files from npm packages:
 
 ```js
-// In the loader script, change this line:
-var b = "https://cdn.iamobi.ai/obi-sdk"
+// The loader automatically uses unpkg.com to load the package:
+var b = "https://unpkg.com/obi-sdk"
 
-// To point to your CDN:
-var b = "https://your-cdn.iamobi.ai/path/to/obi-sdk"
+// Which resolves to URLs like:
+// https://unpkg.com/obi-sdk@0.1.1/dist/obi-sdk.standalone.iife.js
 ```
 
 ### Widget Positioning