diff --git a/apps/docs/public/images/yourgpt-copilot-sdk-npm.png b/apps/docs/public/images/yourgpt-copilot-sdk-npm.png new file mode 100644 index 0000000..3b55362 Binary files /dev/null and b/apps/docs/public/images/yourgpt-copilot-sdk-npm.png differ diff --git a/packages/copilot-sdk/README.md b/packages/copilot-sdk/README.md index 254d04c..0eda3c0 100644 --- a/packages/copilot-sdk/README.md +++ b/packages/copilot-sdk/README.md @@ -1,9 +1,15 @@ -# @yourgpt/copilot-sdk + + YourGPT Copilot SDK + + +# Copilot SDK Build AI Copilots for Your Product. Production-ready AI Copilots for any product. Connect any LLM, deploy on your infrastructure, own your data. +**Documentation:** [copilot-sdk.yourgpt.ai](https://copilot-sdk.yourgpt.ai) + ## Installation ```bash @@ -34,46 +40,23 @@ function App() { | `/ui` | Pre-built UI components | | `/core` | Types, utilities, tool helpers | -## Styling (Tailwind CSS v4) - -```css -/* app/globals.css */ -@import "tailwindcss"; - -/* IMPORTANT: Path is relative to your CSS file location */ -/* If globals.css is in app/ folder, use ../ prefix */ -@source "../node_modules/@yourgpt/copilot-sdk/dist/**/*.{js,ts,jsx,tsx}"; - -@custom-variant dark (&:is(.dark *)); -``` - -> **Note:** The `@source` path must point to `dist/` (not `src/`) and include all file extensions `{js,ts,jsx,tsx}`. +## Examples -> **Important:** For Tailwind v4, you also need the `@theme inline` block to map CSS variables like `--background` to Tailwind utilities like `bg-background`. If you have shadcn/ui, this is already configured. Otherwise, see the [Quick Start guide](https://copilot-sdk.yourgpt.ai/docs/quickstart) for complete setup. - -## Theming - -Works automatically with existing shadcn/ui setup. For projects without shadcn: - -```tsx -import "@yourgpt/copilot-sdk/ui/styles.css"; -import "@yourgpt/copilot-sdk/ui/themes/claude.css"; // Optional preset - -
- -
; -``` +Explore real-world implementations and demo projects. -**8 theme presets available:** Claude, Vercel, Supabase, Twitter, Linear, PostHog, Catppuccin, Modern + + Debug Assistant + -## Documentation + + Support Ticket System + -Visit [copilot-sdk.yourgpt.ai](https://copilot-sdk.yourgpt.ai) for full documentation including: + + SaaS Application + -- Theme customization & CSS variables -- Semantic CSS classes (`csdk-*`) -- Creating custom themes -- Dark mode support +**[View all examples →](https://copilot-sdk.yourgpt.ai/docs/examples)** ## License diff --git a/packages/copilot-sdk/package.json b/packages/copilot-sdk/package.json index 8a3b921..ccc9d93 100644 --- a/packages/copilot-sdk/package.json +++ b/packages/copilot-sdk/package.json @@ -3,6 +3,7 @@ "version": "2.0.0", "description": "Copilot SDK for building Production-ready AI Copilots for any product. Connect any LLM, deploy on your infrastructure, own your data.", "type": "module", + "types": "./dist/core/index.d.ts", "exports": { "./core": { "types": "./dist/core/index.d.ts",