@askdialog/dialog-sdk 1.0.1 → 1.0.3

package/README.md

@@ -1,10 +1,26 @@
-# Dialog Custom SDK
+# Dialog SDK
+
+## Dialog
+
+Dialog is an AI assistant designed to boost e-commerce sales by providing intelligent product recommendations and seamless customer interactions.
+
+Visit our website: [Dialog AI Assistant](https://www.askdialog.com/)
+
+Need to see it in action? [Request one here](https://w1rsh3lwqfo.typeform.com/to/VxHL0RBR?typeform-source=dialog-sdk)
 
 ## Description
 
-Dialog Custom SDK is a TypeScript library that allows easy integration of the Dialog assistant.
+Dialog SDK is a powerful TypeScript library that seamlessly integrates the Dialog AI assistant into your applications. It provides a comprehensive set of tools for managing assistant interactions, handling e-commerce operations like product fetching and cart management, and customizing the assistant's appearance to match your brand.
+
+## Get started
+
+### Prerequisites
+
+Before using the Dialog SDK, you need:
 
-## Installation
+- An active API Key, you can retrieve your api key in your [organization settings](https://app.askdialog.com/settings)
+
+### Installation
 
 ```bash
 npm install @dialog/dialog-sdk
@@ -14,9 +30,78 @@ pnpm add @dialog/dialog-sdk
 yarn add @dialog/dialog-sdk
 ```
 
-## Main Features
+### Instantiate the client
+
+```typescript
+import { Dialog } from '@dialog/dialog-sdk';
+
+const client = new Dialog({
+  apiKey: 'YOUR_API_KEY', // required
+  locale: 'TARGETED_LOCALE', // required
+  callbacks: {
+    addToCart: () => Promise<void>, // required
+    getProduct: () => Promise<Product>, // required
+  },
+});
+```
+
+The apiKey is required to authenticate with our API and interact with our assistant.
+The locale specifies the language you want to use.
+The addToCart function is triggered when a user clicks the AddToCart button.
+The getProduct function is used to display product information in the assistant.
+
+### Features
+
+- Send a message with context
+
+```typescript
+ client.sendProductMessage({
+    question: 'YOUR_QUESTION', // required
+    productId: 'PRODUCT_ID', // required
+    productTitle: 'PRODUCT_TITLE', // required
+    answer: '', // Optional
+    selectedVariantId?: 'CURRENT_VARIANT_ID', // Optional
+ })
+```
+
+- Send message without context
+
+```typescript
+client.sendGenericMessage({
+  question: 'YOUR_QUESTION', // required
+});
+```
 
-- Assistant controls (open / close / send message)
 - Handler for fetch product
+
+```typescript
+const client = new Dialog({
+    ...,
+    callbacks: {
+        getProduct: () => {
+            // Call your api to retrieve product information
+            const response = await fetch('....');
+            const data = await response.json();
+            // To define
+            return {};
+        }
+    },
+});
+```
+
 - Handler for add to cart
-- Assistant theming
+
+```typescript
+const client = new Dialog({
+    ...,
+    callbacks: {
+        addToCart: () => {
+            // Call your api to trigger addToCart
+            const response = await fetch('....');
+
+            // Trigger other stuff like confirmation modal
+            return;
+        }
+    },
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@askdialog/dialog-sdk",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "private": false,
   "description": "Dialog SDK",
   "main": "dist/index.js",
@@ -15,7 +15,14 @@
   "files": [
     "dist"
   ],
-  "keywords": [],
+  "keywords": [
+    "dialog",
+    "ai",
+    "assistant",
+    "ecommerce",
+    "sdk",
+    "typescript"
+  ],
   "author": "Dialog",
   "license": "MIT",
   "devDependencies": {