@webless/agent 0.2.0 → 0.2.7

package/README.md

@@ -1,121 +1,37 @@
-# `@webless/agent`
+# @webless/agent
 
-Webless Agent SDK — Eve runtime client, React UI, embed mount API, and IIFE bundle builder.
+Webless Agent — AI assist for your site.
 
-## Install
+## Get started
 
-```bash
-npm install @webless/agent eve react react-dom
-```
-
-`react` and `react-dom` are required for `@webless/agent/react` and `@webless/agent/embed`.
-
-## Headless client
-
-```ts
-import { createAgentClient, pingAgentHealth } from "@webless/agent";
-
-const health = await pingAgentHealth("https://runtime.staging.webless.ai");
-console.log(health.ok ? "ready" : health.detail);
-
-const agent = createAgentClient({
-  indexId: "YOUR_PUBLISHED_INDEX_ID",
-  runtimeOrigin: "https://runtime.staging.webless.ai",
-});
-
-const reply = await agent.sendTurn("What can you help me with?", {
-  handlers: {
-    onDelta: (delta) => process.stdout.write(delta),
-  },
-});
-```
-
-## React UI
-
-```tsx
-import { AgentRail, useAgentChat } from "@webless/agent/react";
-import "@webless/agent/react.css";
-
-function AssistPanel({ indexId }: { indexId: string }) {
-  const { state, submit } = useAgentChat({ indexId });
-
-  return (
-    <AgentRail
-      state={state}
-      onSubmit={(message) => void submit(message)}
-      onFollowUpSelect={(label) => void submit(label)}
-    />
-  );
-}
-```
-
-## Embed API (programmatic mount)
-
-```ts
-import { mountAgent, unmountAgent } from "@webless/agent/embed";
-
-const handle = mountAgent({
-  manifest: {
-    customerId: "cust_123",
-    indexId: "idx_abc",
-    runtimeOrigin: "https://runtime.staging.webless.ai",
-    placement: { side: "right", along: 50, inset: 0, variant: "outline" },
-  },
-});
-
-handle.open();
-handle.close();
-handle.unmount();
-// or unmountAgent("cust_123");
-```
+1. Sign up at [app.webless.ai](https://app.webless.ai)
+2. Create and publish an index
+3. Open **Agent Studio** for that index
+4. Build a preview bundle, then copy the **install snippet**
+5. Paste the snippet into your site HTML
 
-v1 defaults to a right-side edge tab + collapsible rail (Agent Studio tokens).
+That is the full integration. Webless builds and hosts the agent script for you.
 
-## Customer IIFE bundle (`agent.js`)
-
-Build a copy-paste script bundle with manifest baked in:
-
-```bash
-cd packages/agent
-npm run build:bundle -- \
-  --manifest examples/agent.manifest.json \
-  --customer-id demo_customer \
-  --out-dir dist/bundles
-```
-
-Output: `dist/bundles/agent.js` exposing `window.WeblessAgent`:
+The snippet is a single script tag, for example:
 
 ```html
-<script src="https://agents.webless.ai/demo_customer/agent.js" async></script>
-<script>
-  window.WeblessAgent?.open();
-</script>
+<script defer src="…"></script>
 ```
 
-## Runtime endpoints
+The exact URL is generated in the console when you build your bundle.
 
-| Operation | Request |
-|-----------|---------|
-| Health | `GET /eve/v1/health` |
-| Start session | `POST /eve/v1/session?indexId=<index-id>` |
-| Continue session | `POST /eve/v1/session/:sessionId?indexId=<index-id>` |
-| Resume stream | `GET /eve/v1/session/:sessionId/stream?indexId=<index-id>` |
+## What you get
 
-## Local browser demo
+- A collapsible assist panel on your site
+- Answers grounded in your published index
+- Edge tab launcher (position configured in Agent Studio)
+- Session continuity for returning visitors
 
-```bash
-cd webless-sdk
-cp apps/agent-demo/.env.example apps/agent-demo/.env.local
-npm install
-npm run dev:agent
-```
 
-Open **http://127.0.0.1:5178** for the headless Eve streaming demo.
+## This npm package
+
+`@webless/agent` is published for Webless tooling and internal use. It powers the script bundle served from the console install flow.
 
-## Exports
+Customers integrate via the **console snippet only** — not via `@webless/agent/react` or a direct npm dependency.
 
-| Subpath | Purpose |
-|---------|---------|
-| `@webless/agent` | Headless Eve client |
-| `@webless/agent/react` | AgentRail, AssistEdgeTab, `useAgentChat` |
-| `@webless/agent/embed` | `mountAgent`, manifest normalization |
+If you are building on Webless internally, see the package source and `apps/agent-demo` in the [webless-sdk](https://github.com/tech-webless/webless-sdk) repo.