update readme

This commit is contained in:
Aman Varshney
2025-02-15 03:52:38 +05:30
parent e15dae37f1
commit be5c662905
3 changed files with 36 additions and 59 deletions

View File

@@ -0,0 +1,5 @@
---
"create-better-t-stack": patch
---
update readme

View File

@@ -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)

View File

@@ -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",