@yourgpt/copilot-sdk 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,30 +1,40 @@
1
1
  # @yourgpt/copilot-sdk
2
2
 
3
- Build AI copilots with app context awareness.
3
+ Build AI Copilots for Your Product.
4
+
5
+ Production-ready AI Copilots for any product. Connect any LLM, deploy on your infrastructure, own your data.
4
6
 
5
7
  ## Installation
6
8
 
7
9
  ```bash
8
- npm install @yourgpt/copilot-sdk
10
+ npm install @yourgpt/copilot-sdk @yourgpt/llm-sdk
9
11
  ```
10
12
 
11
- ## Usage
13
+ ## Quick Start
12
14
 
13
15
  ```tsx
14
- // React hooks & provider
15
- import {
16
- CopilotProvider,
17
- useTools,
18
- useAIContext,
19
- } from "@yourgpt/copilot-sdk/react";
20
-
21
- // UI components
16
+ import { CopilotProvider } from "@yourgpt/copilot-sdk/react";
22
17
  import { CopilotChat } from "@yourgpt/copilot-sdk/ui";
23
-
24
- // Core types and utilities
25
- import { tool, success, type ToolDefinition } from "@yourgpt/copilot-sdk/core";
18
+ import "@yourgpt/copilot-sdk/ui/styles.css";
19
+
20
+ function App() {
21
+ return (
22
+ <CopilotProvider runtimeUrl="/api/chat">
23
+ <YourApp />
24
+ <CopilotChat />
25
+ </CopilotProvider>
26
+ );
27
+ }
26
28
  ```
27
29
 
30
+ ## Subpath Exports
31
+
32
+ | Subpath | Description |
33
+ | -------- | ------------------------------ |
34
+ | `/react` | React hooks and provider |
35
+ | `/ui` | Pre-built UI components |
36
+ | `/core` | Types, utilities, tool helpers |
37
+
28
38
  ## Styling (Tailwind CSS v4)
29
39
 
30
40
  Add the SDK source to your Tailwind config:
@@ -44,17 +54,9 @@ For theming, optionally import the default CSS variables:
44
54
  @import "@yourgpt/copilot-sdk/ui/styles.css";
45
55
  ```
46
56
 
47
- ## Subpath Exports
48
-
49
- | Subpath | Description |
50
- | -------- | ------------------------------ |
51
- | `/core` | Types, utilities, tool helpers |
52
- | `/react` | React hooks and provider |
53
- | `/ui` | Pre-built UI components |
54
-
55
57
  ## Documentation
56
58
 
57
- Visit [https://copilot-sdk.yourgpt.ai](https://copilot-sdk.yourgpt.ai)
59
+ Visit [copilot-sdk.yourgpt.ai](https://copilot-sdk.yourgpt.ai)
58
60
 
59
61
  ## License
60
62