@telnyx/ai-chat-widget 4.2.0 → 5.0.0

package/README.md

@@ -1,34 +1,18 @@
 # AI Widget Setup (local)
 
-This is a simple guide to setup the AI Widget in your project.
+This is a simple guide to run the AI Widget's demo app locally.
 
 ## Prerequisites
 
-1. Node.js
-2. pnpm
+1. Node.js (see `.nvmrc` at the repo root)
+2. npm
 
-### Step 1: Create a new flow at flow.telnyx.com
+## Setup
 
-1. Go to [flow.telnyx.com](https://flow.telnyx.com)
-2. Create a new flow
+1. From the repo root, install dependencies: `npm install`
+2. Set the widget's `chatAPIUrl` prop to your AIDA support-agent endpoint —
+   see the root `README.md` for the full prop reference.
+3. Build the widget so the demo can resolve it: `npm run build -w packages/ai-chat-widget`
+4. Run the demo: `npm run dev --workspace=demo`
 
-#### Step 1.1: Setup the flow trigger and response
-
-1. Make the request trigger a `GET` request
-2. Make the arguments `question`, `sessionId`, and `userId` as query parameters
-3. Make the response a `stream` response.
-
-### Step 2: Setup the flow URL in local ai-widget's code
-
-1. Search for `flowBaseUrl` in the code
-2. Replace the value with the flow URL
-3. Replace the URL `api.telnyx.com/v2` with `localhost:5173` or the URL where the ai-widget is hosted
-
-### Step 3: Setup the vite proxy with Bearer token
-
-1. Replace the Bearer token with the token from the Telnyx portal in the `vite.config.js` file.
-
-### Step 4: Run the project
-
-1. Install the dependencies using `pnpm install`
-2. Run the project using `pnpm run dev`
+See `apps/demo/.env.example` for the environment variables the demo app reads.