@autoblogwriter/sdk 3.0.0 → 3.0.1

package/README.md

@@ -14,7 +14,7 @@ npm install @autoblogwriter/sdk
 
 ## v3 Migration (Breaking Changes)
 
-Version `3.0.0` removes legacy `BlogAuto*` symbols and legacy webhook/env identifiers.
+Version `3.0.0` removes legacy `BlogAuto*` symbols and legacy webhook/env identifiers. There are no compatibility aliases in v3.
 
 ### API Rename Map
 
@@ -68,6 +68,34 @@ import "@autoblogwriter/sdk/styles.css";
 | `@autoblogwriter/sdk/revalidate` | Server | `createRevalidateRouteHandler`, `verifyWebhookSignature` |
 | `@autoblogwriter/sdk/styles.css` | Client | Default dark-theme styles for all components |
 
+## Quick Start (Next.js App Router)
+
+1. Install the package:
+
+```bash
+npm install @autoblogwriter/sdk
+```
+
+2. Configure environment variables:
+
+```bash
+AUTOBLOGWRITER_API_KEY=ba_pk_your_api_key
+AUTOBLOGWRITER_WORKSPACE_SLUG=your-workspace
+AUTOBLOGWRITER_REVALIDATE_SECRET=your_webhook_secret
+```
+
+3. Fetch and render posts:
+
+```tsx
+import { fetchBlogPosts } from "@autoblogwriter/sdk/next";
+import { BlogPostList } from "@autoblogwriter/sdk/react";
+
+export default async function BlogPage() {
+  const { posts } = await fetchBlogPosts({ limit: 20 });
+  return <BlogPostList posts={posts} />;
+}
+```
+
 ## Security Notes (Read First)
 - Never ship AutoBlogWriter API keys in public, client-side code.
 - Run the SDK inside Next.js server components, route handlers, or your own backend proxy.
@@ -358,36 +386,6 @@ For a light theme, override the color variables:
 | `.ba-post-meta` | `<BlogPost>` | Date and reading time |
 | `.ba-markdown` | `<Markdown>` | Markdown content wrapper |
 
-## Low-Level Client Configuration
-
-For advanced use cases where you need more control than the env-based helpers provide, you can create a client directly:
-
-```ts
-import { createAutoBlogWriterClient } from "@autoblogwriter/sdk";
-
-const client = createAutoBlogWriterClient({
-  apiUrl: "https://api.autoblogwriter.app",
-  apiKey: process.env.AUTOBLOGWRITER_API_KEY!,
-  workspaceId: process.env.AUTOBLOGWRITER_WORKSPACE_ID,
-  workspaceSlug: process.env.AUTOBLOGWRITER_WORKSPACE_SLUG,
-  authMode: "bearer",           // or "x-api-key"
-  headers: { "x-trace-id": "..." },
-  timeoutMs: 10_000,
-  fetch: globalThis.fetch,       // optional custom fetch
-});
-```
-
-| Option | Type | Required | Description |
-| --- | --- | --- | --- |
-| `apiUrl` | `string` | yes | Root API URL, e.g. `https://api.autoblogwriter.app`. Trailing slash removed automatically. |
-| `apiKey` | `string` | yes | Workspace-scoped API key created in the AutoBlogWriter dashboard. |
-| `workspaceId` | `string` | one of `workspaceId` or `workspaceSlug` | Optional; used for account scoping. |
-| `workspaceSlug` | `string` | one of `workspaceId` or `workspaceSlug` | Required for public content APIs (`/v1/public/:workspaceSlug/...`). |
-| `authMode` | `"bearer" \| "x-api-key"` | no (default `"bearer"`) | Sends the API key via `Authorization: Bearer` or `x-api-key`. |
-| `headers` | `Record<string, string>` | no | Additional static headers (merged on each request). |
-| `fetch` | `typeof fetch` | no | Provide a custom fetch implementation (e.g., for SSR polyfills). |
-| `timeoutMs` | `number` | no | Optional request timeout enforced client-side. |
-
 ## Revalidation
 
 When AutoBlogWriter publishes a post it can ping your Next.js site so cached pages refresh immediately.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autoblogwriter/sdk",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Official AutoBlogWriter SDK for fetching posts, building sitemaps, rendering helpers, and revalidation utilities.",
   "license": "MIT",
   "type": "module",