update readme

README.md

@@ -1,72 +1,47 @@
-# Create Better-T-Stack
+# Better-T-Stack
 
-A CLI tool to scaffold Better-T Stack projects with best practices and modern tooling.
+Better-T-Stack is a project scaffolding system for creating modern TypeScript applications with complete type safety from frontend to backend.
 
-## Features
+## Repository Structure
 
-- 🚀 Quick project setup with one command
+This repository is organized as a monorepo containing:
-- 📦 TypeScript/JavaScript support
+
-- 🗄️ Database options (libSQL/PostgreSQL)
+- **CLI**: [`create-better-t-stack`](apps/cli) - A scaffolding CLI that creates type-safe TypeScript projects
-- 🔒 Optional authentication setup
+- **Documentation**: [`web`](apps/web) - The official website and documentation
-- 🐳 Docker configuration
-- 🔄 GitHub Actions workflows
-- 🎯 SEO optimization
 
 ## Quick Start
 
 ```bash
 # Using npm
-npx create-better-t my-app
+npx create-better-t-stack my-app
 
 # Using bun
-bunx create-better-t my-app
+bunx create-better-t-stack my-app
 ```
 
-Just follow the interactive prompts!
+## Features
 
-## Options
+- 🚀 Fast project setup with interactive CLI
+- 📦 Complete TypeScript type safety from database to frontend
+- 🗄️ Multiple database options (libSQL/PostgreSQL)
+- 🧩 Choice of ORMs (Drizzle or Prisma)
+- 🔒 Built-in authentication with Better-Auth
+- 🐳 Optional Docker configuration
+- 🔄 Optional GitHub Actions workflows
 
-```bash
+## Documentation
-Usage: create-better-t [project-directory] [options]
 
-Options:
+Visit [better-t-stack.pages.dev](https://better-t-stack.pages.dev) for full documentation.
-  --typescript     Use TypeScript (default)
-  --javascript    Use JavaScript
-  --git           Initialize git repository (default)
-  --no-git        Skip git initialization
-  -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:
-
 ```bash
 # Clone the repository
-git clone https://github.com/your-username/better-t-stack-cli.git
+git clone https://github.com/better-t-stack/create-better-t-stack.git
 
 # Install dependencies
 bun install
 
 # Start development
 bun dev
-
-# Build
-bun run build
 ```
-
-## 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)

apps/cli/README.md

@@ -2,20 +2,32 @@
 
 > **Note:** This CLI is currently a work in progress (WIP).
 
-An interactive CLI tool to quickly scaffold full-stack applications using the Better-T-Stack framework.
+An interactive CLI tool to quickly scaffold full-stack TypeScript applications using the Better-T-Stack framework.
 
 ## Quick Start
 
 Run without installing globally:
 
 ```bash
-npx create-better-t-stack
+npx create-better-t-stack@latest
 # OR
 bunx create-better-t-stack
 ```
 
 Follow the prompts to configure your project.
 
+## Features
+
+- **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
+- **Developer Experience**: Git initialization, various package manager support (npm, pnpm, yarn, bun)
+- **Deployment**: Optional Docker configuration
+- **CI/CD**: Optional GitHub Actions workflows
+
 ## Usage
 
 ```bash
@@ -40,26 +52,44 @@ Options:
   --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
 ```
 
-## Features
+## Examples
 
-- **Project Setup**: Scaffold a full-stack TypeScript project with a monorepo structure
+Create a project with default configuration:
-- **Database Options**: Choose between SQLite (via Turso), PostgreSQL, or no database
+```bash
-- **Authentication**: Optional auth setup with Better-Auth
+npx create-better-t-stack my-app -y
-- **ORM Selection**: Choose between Drizzle ORM or Prisma
+```
-- **Deployment**: Optional Docker configuration
-- **CI/CD**: GitHub Actions workflows
-- **Developer Experience**: Git initialization and package manager selection
 
-## Stack
+Create a project with specific options:
+```bash
+npx create-better-t-stack my-app --postgres --prisma --auth --docker
+```
 
-The generated project includes:
+## Project Structure
 
-- **Frontend**: React, TanStack Router, TanStack Query
+The generated project follows a Turborepo monorepo structure:
-- **Backend**: Hono, tRPC
+
-- **Styling**: Tailwind CSS with shadcn/ui components
+```
-- **Database**: SQLite (Turso) or PostgreSQL with your choice of ORM
+my-app/
+├── packages/
+│   ├── client/         # Frontend application (React, TanStack Router)
+│   └── server/         # Backend API (Hono, tRPC)
+├── package.json        # Root package.json with Turborepo configuration
+└── README.md           # Project documentation
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT
 
 Created by [Nitish Singh](https://github.com/FgrReloaded) & [Aman Varshney](https://github.com/AmanVarshney01)