From be5c66290579268e1851dcb2881ffcad07b3fff0 Mon Sep 17 00:00:00 2001
From: Aman Varshney <amanvarshney.work@gmail.com>
Date: Sat, 15 Feb 2025 03:52:38 +0530
Subject: [PATCH] update readme

---
 .changeset/serious-pumas-cover.md |  5 ++
 apps/cli/README.md                | 84 +++++++++----------------------
 apps/cli/package.json             |  6 +++
 3 files changed, 36 insertions(+), 59 deletions(-)
 create mode 100644 .changeset/serious-pumas-cover.md

diff --git a/.changeset/serious-pumas-cover.md b/.changeset/serious-pumas-cover.md
new file mode 100644
index 0000000..effa1f7
--- /dev/null
+++ b/.changeset/serious-pumas-cover.md
@@ -0,0 +1,5 @@
+---
+"create-better-t-stack": patch
+---
+
+update readme
diff --git a/apps/cli/README.md b/apps/cli/README.md
index 171dd5a..0a046b3 100644
--- a/apps/cli/README.md
+++ b/apps/cli/README.md
@@ -1,72 +1,38 @@
-# 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 applications using the Better-T-Stack framework.
 
 ## 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
+# OR
+bunx create-better-t-stack
 ```
 
-Just follow the interactive prompts!
+Follow the prompts to configure your project.
 
-## Options
+## 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
+  -y, --yes             Use default configuration
+  --database <type>     "libsql" (default) or "postgres"
+  --auth                Enable authentication
+  --no-auth             Disable authentication
+  --docker              Include Docker setup
+  --github-actions      Add GitHub Actions workflows
+  --seo                 Configure SEO optimizations
+  --git                 Initialize a new git repo (default)
+  --no-git              Skip git initialization
+  --npm                 Use npm as package manager
+  --pnpm                Use pnpm as package manager
+  --yarn                Use yarn as package manager
+  --bun                 Use bun as package manager
+  -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
-
-# 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)
+Created by [Nitish Singh](https://github.com/nitishsinghal) & [Aman Varshney](https://github.com/AmanVarshney01)
diff --git a/apps/cli/package.json b/apps/cli/package.json
index 617708d..ea29641 100644
--- a/apps/cli/package.json
+++ b/apps/cli/package.json
@@ -8,6 +8,12 @@
 		"create-better-t-stack": "dist/index.js"
 	},
 	"keywords": [],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/better-t-stack/create-better-t-stack.git",
+		"directory": "apps/cli"
+	},
+	"homepage": "https://github.com/better-t-stack/create-better-t-stack/tree/main/apps/cli#readme",
 	"scripts": {
 		"build": "tsup",
 		"dev": "tsup --watch",