@cadraos/sdk 0.1.6 → 0.1.8

package/README.md

@@ -1,6 +1,37 @@
 # @cadraos/sdk
 
-Official SDK for the AI SaaS platform - programmatic access to agents, skills, tools, and artifacts.
+Official SDK for the CadraOS platform - programmatic access to agents, skills, tools, and artifacts.
+
+> **Note**: For React chat components, use the new [@cadraos/react](https://www.npmjs.com/package/@cadraos/react) package.
+> The `@cadraos/sdk/chat` subpath is deprecated.
+
+## Deprecation Notice
+
+The `@cadraos/sdk/chat` subpath is **deprecated** and will be removed in a future version.
+
+**If you're using React chat components**, please migrate to `@cadraos/react`:
+
+```tsx
+// Before (deprecated)
+import { AgentChat, ChatConfigProvider } from '@cadraos/sdk/chat';
+import '@cadraos/sdk/chat/styles.css';
+
+// After (recommended)
+import '@cadraos/react/styles.css';
+import { CadraCopilot } from '@cadraos/react';
+
+function App() {
+  return (
+    <CadraCopilot
+      apiKey="cdr_live_xxx"
+      orgId={123}
+      agentId="agent-uuid"
+    />
+  );
+}
+```
+
+For full migration instructions, see the [migration guide](https://github.com/cadraos/cadra-sdk/blob/main/packages/react/MIGRATION.md).
 
 ## Installation
 
@@ -15,12 +46,12 @@ yarn add @cadraos/sdk
 ## Quick Start
 
 ```typescript
-import { AISaaSClient } from '@cadraos/sdk';
+import { CadraClient } from '@cadraos/sdk';
 
 // Initialize the client
-const client = new AISaaSClient({
-  apiKey: process.env.AISAAS_API_KEY!,
-  orgId: Number(process.env.AISAAS_ORG_ID),
+const client = new CadraClient({
+  apiKey: process.env.CADRA_API_KEY!,  // e.g., cdr_live_xxx
+  orgId: Number(process.env.CADRA_ORG_ID),
 });
 
 // List available agents
@@ -34,6 +65,8 @@ const execution = await client.agents.executeSync(agents[0].uuid, {
 console.log('Result:', execution.output);
 ```
 
+> **Note**: `AISaaSClient` is deprecated but still works as an alias for `CadraClient`.
+
 ## Authentication
 
 The SDK supports three authentication methods: