diff --git a/.changeset/sharp-houses-follow.md b/.changeset/sharp-houses-follow.md new file mode 100644 index 0000000..effa1f7 --- /dev/null +++ b/.changeset/sharp-houses-follow.md @@ -0,0 +1,5 @@ +--- +"create-better-t-stack": patch +--- + +update readme diff --git a/README.md b/README.md index e4aba1d..34459cf 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,16 @@ pnpm create better-t-stack@latest ## Features -- ⚡️ **Zero-config setup** with interactive CLI wizard -- 🔄 **End-to-end type safety** from database to frontend via tRPC -- 🧱 **Modern stack** with React, Hono/Elysia, and TanStack libraries -- 📱 **Multi-platform** supporting web, mobile (Expo), and desktop applications -- 🗃️ **Database flexibility** with SQLite (Turso) or PostgreSQL options -- 🛠️ **ORM choice** between Drizzle or Prisma -- 🔒 **Built-in authentication** with Better-Auth -- 📱 **Optional PWA support** for installable web applications -- 🖥️ **Desktop app capabilities** with Tauri integration -- 📦 **Monorepo architecture** powered by Turborepo +- **Zero-config setup** with interactive CLI wizard +- **End-to-end type safety** from database to frontend via tRPC +- **Modern stack** with React, Hono/Elysia, and TanStack libraries +- **Multi-platform** supporting web, mobile (Expo), and desktop applications +- **Database flexibility** with SQLite (Turso) or PostgreSQL options +- **ORM choice** between Drizzle or Prisma +- **Built-in authentication** with Better-Auth +- **Optional PWA support** for installable web applications +- **Desktop app capabilities** with Tauri integration +- **Monorepo architecture** powered by Turborepo ## Repository Structure diff --git a/apps/cli/README.md b/apps/cli/README.md index 571d783..b43bad1 100644 --- a/apps/cli/README.md +++ b/apps/cli/README.md @@ -17,7 +17,7 @@ bun create better-t-stack@latest pnpm create better-t-stack@latest ``` -Follow the prompts to configure your project or use the `-y` flag for defaults. +Follow the prompts to configure your project or use the `--yes` flag for defaults. ## Features @@ -69,7 +69,7 @@ Options: Create a project with default configuration: ```bash -npx create-better-t-stack my-app -y +npx create-better-t-stack my-app --yes ``` Create a project with specific options: @@ -84,7 +84,7 @@ npx create-better-t-stack my-app --backend elysia --runtime node Create a project with specific frontend options: ```bash -npx create-better-t-stack my-app --frontend web native +npx create-better-t-stack my-app --frontend tanstack-router native ``` Create a project with examples: diff --git a/apps/cli/package.json b/apps/cli/package.json index 07c406e..6584b68 100644 --- a/apps/cli/package.json +++ b/apps/cli/package.json @@ -12,16 +12,14 @@ "dist" ], "keywords": [ + "better-t-stack", "typescript", - "scaffold", - "generator", "boilerplate", "starter", "cli", - "create-app", - "t3-stack", "turborepo", "trpc", + "better-auth", "monorepo", "fullstack", "type-safety", diff --git a/apps/cli/src/helpers/post-installation.ts b/apps/cli/src/helpers/post-installation.ts index 5dc7924..b8f8e1f 100644 --- a/apps/cli/src/helpers/post-installation.ts +++ b/apps/cli/src/helpers/post-installation.ts @@ -58,7 +58,9 @@ ${ ? `${hasWebFrontend ? `${pc.cyan("•")} Frontend: http://localhost:${hasReactRouter ? "5173" : "3001"}\n` : ""}` : `${pc.yellow("NOTE:")} You are creating a backend-only app (no frontend selected)\n` }${pc.cyan("•")} API: http://localhost:3000 -${nativeInstructions ? `\n${nativeInstructions.trim()}` : ""}${databaseInstructions ? `\n${databaseInstructions.trim()}` : ""}${tauriInstructions ? `\n${tauriInstructions.trim()}` : ""}${lintingInstructions ? `\n${lintingInstructions.trim()}` : ""}${pwaInstructions ? `\n${pwaInstructions.trim()}` : ""}`, +${nativeInstructions ? `\n${nativeInstructions.trim()}` : ""}${databaseInstructions ? `\n${databaseInstructions.trim()}` : ""}${tauriInstructions ? `\n${tauriInstructions.trim()}` : ""}${lintingInstructions ? `\n${lintingInstructions.trim()}` : ""}${pwaInstructions ? `\n${pwaInstructions.trim()}` : ""} +\n${pc.bold("Like Better-T Stack?")} Please consider giving us a star on GitHub: +${pc.cyan("https://github.com/better-t-stack/create-better-t-stack")}`, "Next steps", ); }