@sprout_ai_labs/sidekick 1.0.1 → 1.0.3

package/README.md

@@ -7,13 +7,17 @@ A Vue 3 plugin providing responsive chat components with custom Sidekick brandin
 ## Features
 
 - 🎨 **Custom Branding**: Built-in Sidekick design with Rubik font
-- 💬 **Chat Components**: Ready-to-use chat interface components
-- 🔄 **Shared State**: Automatic state synchronization between components
+- 💬 **Unified Components**: Ready-to-use chat interface with built-in state management
+- 🎯 **Standalone Components**: Flexible, store-independent components for custom state management
+- 🔄 **Shared State**: Automatic state synchronization (unified components)
+- 🧠 **Thinking Process**: Collapsible thought displays with streaming animations
 - 📱 **Responsive**: Mobile-friendly design
-- 🎯 **TypeScript**: Full TypeScript support
+- 💻 **TypeScript**: Full TypeScript support with comprehensive types
 - 🎨 **Tailwind CSS**: Styled with Tailwind CSS
 - ⚡ **Vue 3**: Built for Vue 3 with Composition API
 - 🔔 **Error Handling**: Built-in snackbar notifications for errors and success messages
+- 📝 **Markdown Support**: Rich text rendering in messages
+- 🔍 **KB Sources**: Citation support for knowledge base sources
 
 ## Demo
 
@@ -73,7 +77,13 @@ onMounted(() => {
 
 ## Components
 
-### SidekickChat
+The plugin provides two types of components:
+
+### 🔄 Unified Components (with built-in store)
+
+Perfect for quick setup with automatic state management:
+
+#### SidekickChat
 
 The main chat interface component for full-page chat experiences.
 
@@ -81,7 +91,7 @@ The main chat interface component for full-page chat experiences.
 <SidekickChat />
 ```
 
-### SidekickChatPlugin
+#### SidekickChatPlugin
 
 A floating chat widget component that can be positioned anywhere on the page.
 
@@ -89,13 +99,60 @@ A floating chat widget component that can be positioned anywhere on the page.
 <SidekickChatPlugin />
 ```
 
-### Additional Components
+### 🎯 Standalone Components (no store dependencies)
+
+Perfect for custom state management and maximum flexibility:
+
+```vue
+<script setup>
+import {
+  SidekickMessages,
+  SidekickChatInput,
+  SidekickCollapsibleThought,
+  SidekickCollapsibleThoughtStreaming
+} from '@sprout_ai_labs/sidekick'
+</script>
+
+<template>
+  <!-- Message display with streaming support -->
+  <SidekickMessages
+    :messages="messages"
+    :is-typing="isTyping"
+    :current-thoughts="currentThoughts"
+    :current-chunked-message="currentChunkedMessage"
+  />
+
+  <!-- Chat input with auto-expand -->
+  <SidekickChatInput
+    @submit="handleSubmit"
+    @input="handleInput"
+  />
+
+  <!-- Completed thinking process -->
+  <SidekickCollapsibleThought
+    :steps="thoughtSteps"
+    :duration="thinkingDuration"
+  />
+
+  <!-- Real-time streaming thoughts -->
+  <SidekickCollapsibleThoughtStreaming
+    :steps="liveThoughts"
+  />
+</template>
+```
+
+**Standalone components** work via props and events only - no store required! Perfect for:
+- Integrating into existing applications with custom state
+- Building chat interfaces in Sidekick Central
+- Maximum control over state management
+
+See the [Standalone Components Documentation](https://spr-sidekick-docs.azurewebsites.net/api/standalone-components) for full details.
 
-The plugin also includes:
+### 🛠️ Utility Components
 
-- `SidekickChatInput` - Standalone chat input component
-- `SidekickLoader` - Loading animation component
-- `SidekickMessages` - Message display component
+- `SidekickLoader` - Animated loading indicator
+- `SidekickLogo` - Sidekick logo component
+- `SidekickChatSources` - Knowledge base source citations
 
 ## Plugin Options