@akropolys/kiku 2.2.26 → 2.2.28

package/README.md

@@ -1,78 +1,89 @@
 # @akropolys/kiku
 
-Pre-built, blindly agnostic multi-modal conversational AI widget with duplex Live Voice, Computer Vision, and real-time comparative tables for any website or transactional platform.
+Chat, search, voice, and photo input for your website. Kiku connects visitors to your content and the API actions you configure in Akropolys.
 
 [![npm](https://img.shields.io/npm/v/@akropolys/kiku?color=orange)](https://www.npmjs.com/package/@akropolys/kiku) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![TypeScript](https://img.shields.io/badge/types-included-blue)](https://www.typescriptlang.org/)
 
----
-
 ## Install
 
 ```bash
 npm install @akropolys/kiku @akropolys/sdk
-# or
-pnpm add @akropolys/kiku @akropolys/sdk
 ```
 
----
+Requires React and React DOM 17 or later. For websites without React, use the [script embed](https://github.com/akropolys/sdk/blob/HEAD/packages/kiku/EMBED.md).
 
-## Usage (React / Next.js)
+## React and Next.js
 
 ```tsx
+'use client';
+
 import { AkropolysProvider } from '@akropolys/sdk';
 import { KikuButton } from '@akropolys/kiku';
-import '@akropolys/kiku/styles.css'; // required: the chat window copies its rules from this sheet (serve it same-origin, or with crossorigin="anonymous")
+import '@akropolys/kiku/styles.css';
 
-export default function App() {
+export default function WebsiteAssistant() {
   return (
     <AkropolysProvider
       siteId={process.env.NEXT_PUBLIC_AKROPOLYS_SITE_ID!}
       apiUrl={process.env.NEXT_PUBLIC_AKROPOLYS_API_URL!}
-      apiToken={process.env.NEXT_PUBLIC_AKROPOLYS_API_KEY!}
+      apiToken={process.env.NEXT_PUBLIC_AKROPOLYS_API_TOKEN!}
     >
-      <KikuButton
-        label="Ask me anything"
-        enableVoice={true}
-        enableVision={true}
-        theme={{
-          borderRadius: "24px",
-        }}
-      />
+      <KikuButton label="Ask us" enableVoice enableVision />
     </AkropolysProvider>
   );
 }
 ```
 
-> **Next.js Note**: If running an experimental Next.js 15/16 canary with Tailwind CSS v4 on Windows, run `next dev --webpack` if Turbopack experiences resolver latency on Windows ([tracked upstream](https://github.com/vercel/next.js/issues)).
+Mount the component once in your app or layout. In Next.js App Router, import the stylesheet in your root layout if that is where your project keeps global CSS.
+
+Use your site's public browser token. Keep private keys and server credentials on your server. Enable the corresponding voice and vision features for your site in Shell.
 
----
+## What visitors can do
 
-## Records and saved history
+- Ask about your content and compare records in tables.
+- Talk using live voice or include photos in a conversation.
+- Open source records and save items for later.
+- Long-press or right-click a message to access its actions.
+- Use translated controls, right-to-left layouts, and chat themes.
 
-Ingest each catalogue record with a stable top-level `id`. Put its optional, recommended webpage link in `fields.url`. Kiku can show and save ID-only records and retains a supplied link in saved history. See the [SDK ingestion guide](../sdk/README.md#batch-ingestion-on-your-server) for examples.
+## Components
 
-## Site actions
+| Component | Purpose |
+| --- | --- |
+| `KikuButton` | A launcher that opens the chat window. |
+| `SearchBar` | Inline search with streamed results. |
 
-Configure permitted actions and their request fields in Shell. Kiku collects the required values and explains the result returned by your backend. Cart updates, bookings, and other operations run through those endpoints; the widget does not maintain a separate cart or dispatch cart reducers.
+Both components use `AkropolysProvider` from `@akropolys/sdk`.
 
-Remove the former action callbacks and browser action listeners when upgrading. See the [SDK action guide](../sdk/README.md#site-actions) for migration details.
+## Customize the launcher
 
-## Components
+```tsx
+<KikuButton
+  label="Ask about this property"
+  title="Your assistant"
+  placeholder="What would you like to know?"
+  chips={['Show available properties', 'Compare my options']}
+  theme="dark"
+  enableVoice
+  enableVision
+/>
+```
 
-| Component | Description |
-|---|---|
-| `<KikuButton />` | Launcher pill that opens the full-screen chat, with live voice and vision. |
-| `<SearchBar />` | Inline catalogue search with streamed results. |
-| `<ScoutRail />` | Dock for the shopper's scouts: send one out, check on it, buy time. |
-| `<ScoutCharacter />` | A single animated scout avatar. |
+`theme` accepts `light`, `dark`, or an `AkropolysTheme` object from `@akropolys/sdk`. Use `onSelectSource` to handle a visitor selecting a source record.
 
+## Your content and actions
 
----
+Give each catalogue record a stable top-level `id`. A webpage link in `fields.url` is optional; Kiku can show and save records without one. See the [SDK ingestion guide](https://github.com/akropolys/sdk/blob/HEAD/packages/sdk/README.md#batch-ingestion-on-your-server).
 
-## License
+Configure action endpoints, HTTP methods, and request fields in Shell. Kiku collects the required values and presents the result returned by your backend. Your endpoint validates the request and performs the operation. See the [site actions guide](https://github.com/akropolys/sdk/blob/HEAD/packages/sdk/README.md#site-actions).
 
-MIT © [Akropolys](https://akropolys.cloud)
+## Links
 
-### Plain HTML and other frameworks
+- [Akropolys](https://akropolys.cloud)
+- [Source code](https://github.com/akropolys/sdk)
+- [Plain HTML embed guide](https://github.com/akropolys/sdk/blob/HEAD/packages/kiku/EMBED.md)
+- [Headless SDK](https://www.npmjs.com/package/@akropolys/sdk)
 
-Use the standalone script embed without installing React on your website. See [EMBED.md](./EMBED.md) for setup, ingestion, and identity updates.
+## License
+
+MIT © [Akropolys](https://akropolys.cloud)