@gr33n-ai/jade-sdk-client 0.1.0

package/README.md

@@ -0,0 +1,123 @@
+# @gr33n-ai/jade-sdk-client
+
+TypeScript/React client for [Jade AI](https://jade.gr33n.ai) - generate images, videos, and audio with AI.
+
+## Installation
+
+```bash
+npm install @gr33n-ai/jade-sdk-client
+# or
+yarn add @gr33n-ai/jade-sdk-client
+# or
+pnpm add @gr33n-ai/jade-sdk-client
+```
+
+## Quick Start
+
+```tsx
+import { JadeProvider, useJadeSession } from '@gr33n-ai/jade-sdk-client/react';
+
+function App() {
+  return (
+    <JadeProvider
+      config={{
+        endpoint: 'https://api.jade.gr33n.ai',
+        getAuthToken: () => 'your-api-key',
+      }}
+    >
+      <Chat />
+    </JadeProvider>
+  );
+}
+
+function Chat() {
+  const { processedConversation, sendMessage, media, isStreaming } = useJadeSession();
+
+  return (
+    <div>
+      {processedConversation.map((entry, i) => (
+        <div key={i}>
+          {entry.entry.text}
+          {entry.mediaUrls?.map(url => <img key={url} src={url} />)}
+        </div>
+      ))}
+      <button onClick={() => sendMessage('Generate an image of a sunset')}>
+        Generate
+      </button>
+    </div>
+  );
+}
+```
+
+## Features
+
+- **Real-time Streaming**: Server-sent events for instant feedback
+- **Media Generation**: Generate images, videos, and audio
+- **Session Management**: Persistent conversations with history
+- **Type-Safe**: Full TypeScript support
+- **React Hooks**: Easy integration with `useJadeSession`
+
+## Documentation
+
+Full documentation available at [docs.gr33n.ai](https://docs.gr33n.ai)
+
+- [TypeScript Quickstart](https://docs.gr33n.ai/quickstart/typescript)
+- [React Hooks Reference](https://docs.gr33n.ai/react/use-jade-session)
+- [API Reference](https://docs.gr33n.ai/api-reference/client)
+
+## API
+
+### JadeProvider
+
+Wrap your app with `JadeProvider` to enable Jade hooks:
+
+```tsx
+<JadeProvider
+  config={{
+    endpoint: 'https://api.jade.gr33n.ai',
+    getAuthToken: () => apiKey,
+    organizationId: 'org_123', // optional
+  }}
+>
+  <App />
+</JadeProvider>
+```
+
+### useJadeSession
+
+Main hook for chat functionality:
+
+```tsx
+const {
+  // State
+  processedConversation,  // Processed entries ready for display
+  media,                   // All generated media
+  isStreaming,             // Currently generating
+  sessionId,               // Current session ID
+
+  // Actions
+  sendMessage,             // Send a message
+  cancel,                  // Cancel streaming
+  clear,                   // Clear conversation
+  loadSession,             // Load previous session
+  reconnect,               // Reconnect to session
+} = useJadeSession();
+```
+
+### useMedia
+
+Extract media from conversation:
+
+```tsx
+const media = useMedia(conversation);
+// Returns: MediaInfo[] with url, type, prompt, model, etc.
+```
+
+## Requirements
+
+- React 18+
+- Node.js 18+ (for SSE support)
+
+## License
+
+MIT