From 1b52fe9b4c995a1f06e8f49f600a339fe407d5de Mon Sep 17 00:00:00 2001 From: olliethedev <3martynov@gmail.com> Date: Tue, 27 Jan 2026 17:04:48 -0500 Subject: [PATCH] docs: update README to include available plugins and improve installation examples --- README.md | 64 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 39 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 0ebd2bf..201604d 100644 --- a/README.md +++ b/README.md @@ -27,20 +27,25 @@ npm install @btst/stack Enable the features you need and keep building your product. -### Examples of installable features - -* Blog -* AI Chat -* CMS -* Newsletter -* Scheduling -* Kanban board -* Analytics dashboard -* Generic forms - -Each feature ships **frontend + backend together**: +### Available plugins + +| Plugin | Description | +|--------|-------------| +| **Blog** | Content management, editor, drafts, publishing, SEO, RSS feeds | +| **AI Chat** | AI-powered chat with conversation history, streaming, and customizable models | +| **CMS** | Headless CMS with custom content types, Zod schemas, and auto-generated forms | +| **Form Builder** | Dynamic form builder with drag-and-drop editor, submissions, and validation | +| **UI Builder** | Visual drag-and-drop page builder with component registry and public rendering | +| **Kanban** | Project management with boards, columns, tasks, drag-and-drop, and priority levels | +| **OpenAPI** | Auto-generated API documentation with interactive Scalar UI | +| **Route Docs** | Auto-generated client route documentation with interactive navigation | +| **Better Auth UI** | Beautiful shadcn/ui authentication components for better-auth | + +Each plugin ships **frontend + backend together**: routes, APIs, database models, React components, SSR, and SEO — already wired. +**Want a specific plugin?** [Open an issue](https://github.com/better-stack-ai/better-stack/issues/new) and let us know! + --- ## Why use it? @@ -57,31 +62,40 @@ You keep your codebase, database, and deployment. ## Minimal usage -lib/better-stack.ts: -```ts +```ts title="lib/better-stack.ts" import { betterStack } from "@btst/stack" import { blogBackendPlugin } from "@btst/stack/plugins/blog/api" +import { createMemoryAdapter } from "@btst/adapter-memory" -export const { handler } = betterStack({ +export const { handler, dbSchema } = betterStack({ + basePath: "/api/data", plugins: { - blog: blogBackendPlugin(blogConfig) - } + blog: blogBackendPlugin() + }, + adapter: (db) => createMemoryAdapter(db)({}) }) ``` -lib/better-stack-client.tsx: -```tsx +```tsx title="lib/better-stack-client.tsx" import { createStackClient } from "@btst/stack/client" import { blogClientPlugin } from "@btst/stack/plugins/blog/client" import { QueryClient } from "@tanstack/react-query" -const client = createStackClient({ - plugins: { - blog: blogClientPlugin(blogConfig) - } -}) +export const getStackClient = (queryClient: QueryClient) => + createStackClient({ + plugins: { + blog: blogClientPlugin({ + apiBaseURL: "http://localhost:3000", + apiBasePath: "/api/data", + siteBaseURL: "http://localhost:3000", + siteBasePath: "/pages", + queryClient, + }) + } + }) ``` -Now you have a working blog: API, DB schema, pages, SSR, and SEO. + +Now you have a working blog with API, pages, SSR, and SEO. See the [full installation guide](https://www.better-stack.ai/docs/installation) for database adapters, auth hooks, and framework-specific setup. ## Database schemas & migrations