create-better-t-stack 0.1.0 → 1.0.2

package/README.md

@@ -1,72 +1,82 @@
-# Create Better-T-Stack
+# Create Better-T-Stack CLI
 
-A CLI tool to scaffold Better-T Stack projects with best practices and modern tooling.
-
-## Features
-
-- 🚀 Quick project setup with one command
-- 📦 TypeScript/JavaScript support
-- 🗄️ Database options (libSQL/PostgreSQL)
-- 🔒 Optional authentication setup
-- 🐳 Docker configuration
-- 🔄 GitHub Actions workflows
-- 🎯 SEO optimization
+An interactive CLI tool to quickly scaffold full-stack TypeScript applications with React, Hono, and tRPC. The Better-T-Stack provides a modern, type-safe development experience with the best tools from the TypeScript ecosystem.
 
 ## Quick Start
 
-```bash
-# Using npm
-npx create-better-t my-app
+Run without installing globally:
 
-# Using bun
-bunx create-better-t my-app
+```bash
+npx create-better-t-stack@latest
+# OR
+bunx create-better-t-stack
 ```
 
-Just follow the interactive prompts!
+Follow the prompts to configure your project.
+
+## Features
 
-## Options
+- **Monorepo**: Turborepo for optimized build system and workspace management
+- **Frontend**: React, TanStack Router, TanStack Query, Tailwind CSS with shadcn/ui components
+- **Backend**: Hono, tRPC
+- **Database Options**: SQLite (via Turso), PostgreSQL, or no database
+- **ORM Selection**: Choose between Drizzle ORM or Prisma
+- **Authentication**: Optional auth setup with Better-Auth
+- **Progressive Web App**: Add PWA support with service workers and installable apps
+- **Desktop Apps**: Build native desktop apps with Tauri integration
+- **Code Quality**: Biome for linting and formatting
+- **Git Hooks**: Husky with lint-staged for pre-commit checks
+- **Examples**: Todo app with full CRUD functionality
+- **Developer Experience**: Git initialization, various package manager support (npm, pnpm, bun)
+
+## Usage
 
 ```bash
-Usage: create-better-t [project-directory] [options]
+Usage: create-better-t-stack [project-directory] [options]
 
 Options:
-  --typescript     Use TypeScript (default)
-  --javascript    Use JavaScript
-  --git           Initialize git repository (default)
-  --no-git        Skip git initialization
-  -h, --help      Display help
+  -V, --version         Output the version number
+  -y, --yes             Use default configuration
+  --no-database         Skip database setup
+  --sqlite              Use SQLite database
+  --postgres            Use PostgreSQL database
+  --auth                Include authentication
+  --no-auth             Disable authentication
+  --pwa                 Include Progressive Web App support
+  --tauri               Include Tauri desktop app support
+  --biome               Include Biome for linting and formatting
+  --husky               Include Husky, lint-staged for Git hooks
+  --no-addons           Skip all additional addons
+  --examples <examples> Include specified examples
+  --no-examples         Skip all examples
+  --git                 Initialize a new git repo (default)
+  --no-git              Skip git initialization
+  --npm                 Use npm as package manager
+  --pnpm                Use pnpm as package manager
+  --bun                 Use bun as package manager
+  --drizzle             Use Drizzle ORM
+  --prisma              Use Prisma ORM
+  --install             Install dependencies (default)
+  --no-install          Skip installing dependencies
+  --turso               Set up Turso for SQLite database (default with sqlite)
+  --no-turso            Skip Turso setup for SQLite database
+  -h, --help            Display help
 ```
 
-## Project Structure
-
-The generated project follows the Better-T Stack architecture:
-- Built with Bun
-- Type-safe database with DrizzleORM
-- Simple authentication system
-- Modern development practices
-
-## Development
-
-To contribute to this CLI:
+## Examples
 
+Create a project with default configuration:
 ```bash
-# Clone the repository
-git clone https://github.com/your-username/better-t-stack-cli.git
-
-# Install dependencies
-bun install
-
-# Start development
-bun dev
+npx create-better-t-stack my-app -y
+```
 
-# Build
-bun run build
+Create a project with specific options:
+```bash
+npx create-better-t-stack my-app --postgres --prisma --auth --pwa --biome
 ```
 
 ## License
 
 MIT
 
-## Credits
-
-Developed by Nitish Singh & Aman Varshney – Built on top of the Better-T Stack by [Aman Varshney](https://github.com/AmanVarshney01/Better-T-Stack)
+Created by [Aman Varshney](https://github.com/AmanVarshney01) & [Nitish Singh](https://github.com/FgrReloaded)