@oyehello/chat 0.1.1 → 0.3.0

package/README.md

@@ -1,6 +1,22 @@
 # @oyehello/chat
 
-Framework-agnostic embeddable chat for oyehello agents — a `<oyehello-chat>` web component with a working default UI, plus a headless `createChatClient()` for custom UIs. Zero framework dependencies.
+Framework-agnostic embeddable chat for oyehello agents — a `<oyehello-chat>` web component that renders a **floating chat launcher** (bottom-right; click to open a chat window), plus a headless `createChatClient()` for custom UIs. Zero framework dependencies.
+
+The widget connects lazily (a session opens the first time the visitor opens the panel), renders assistant replies as **markdown** (sanitized), and has a full launcher → panel experience: an unread badge, expand/maximize, an emoji picker, file attach, a jump-to-latest control, smart auto-scroll, an optional teaser nudge, quick-reply suggestions, and a privacy footer. It follows the visitor's OS light/dark theme by default. Theme the accent with the `--oc-accent` CSS variable. Just drop the tag anywhere on the page; it positions itself as a floating launcher.
+
+### Attributes
+
+| Attribute | Required | What it is |
+| --- | --- | --- |
+| `api-key` | yes | Publishable key (`ohk_pub_…`) |
+| `agent-id` | yes | The chat agent (`agt_…`) |
+| `base-url` | yes | API origin, e.g. `https://api.oyehello.ai` |
+| `title` | no | Header title (defaults to the agent's name) |
+| `theme` | no | `auto` (default, follows the OS), `light`, or `dark` |
+| `teaser` | no | Text for a one-time nudge bubble; omit to disable |
+| `suggestions` | no | Comma-separated quick-reply chips, e.g. `"Book a demo, Pricing"` |
+| `privacy-url` | no | Shows a Privacy-Policy footer linking here |
+| `--oc-accent` (CSS var) | no | Brand accent (default `#096DD9`) |
 
 ## Install
 ```bash
@@ -75,5 +91,5 @@ Register handlers BEFORE `start()` — only tools registered at open are offered
 
 ## Requirements
 - `api-key` is a **publishable** key (`ohk_pub_…`) created in the oyehello console.
-- The agent must have **chat enabled**.
+- The agent must be a **chat-channel agent** (the channel is chosen when the agent is created; a call agent can't answer chat).
 - The page's origin must be on the publishable key's **allowlist**.