Skip to content

Commit 2df8d44

Browse files
chore(web): improve docs and readme
1 parent 51cfb35 commit 2df8d44

File tree

10 files changed

+412
-684
lines changed

10 files changed

+412
-684
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,24 @@ A modern CLI tool for scaffolding end-to-end type-safe TypeScript projects with
1010

1111
![demo](https://cdn.jsdelivr.net/gh/amanvarshney01/create-better-t-stack/demo.gif)
1212

13+
## Philosophy
14+
15+
- Roll your own stack: you pick only the parts you need, nothing extra.
16+
- Minimal templates: bare-bones scaffolds with zero bloat.
17+
- Latest dependencies: always use current, stable versions by default.
18+
- Free and open source: forever.
19+
1320
## Quick Start
1421

1522
```bash
16-
# Using npm
17-
npx create-better-t-stack@latest
18-
19-
# Using bun
23+
# Using bun (recommended)
2024
bun create better-t-stack@latest
2125

2226
# Using pnpm
2327
pnpm create better-t-stack@latest
28+
29+
# Using npm
30+
npx create-better-t-stack@latest
2431
```
2532

2633
## Features
@@ -37,7 +44,7 @@ pnpm create better-t-stack@latest
3744
- DB Setup: Turso, Neon, Supabase, Prisma PostgreSQL, MongoDB Atlas, Cloudflare D1, Docker
3845
- Web Deploy: Cloudflare Workers
3946

40-
Type safety end-to-end, clean monorepo layout, and zerolockin: you choose only what you need.
47+
Type safety end-to-end, clean monorepo layout, and zero lock-in: you choose only what you need.
4148

4249
## Repository Structure
4350

apps/cli/README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ A modern CLI tool for scaffolding end-to-end type-safe TypeScript projects with
1515
Run without installing globally:
1616

1717
```bash
18-
# Using npm
19-
npx create-better-t-stack@latest
20-
21-
# Using bun
18+
# Using bun (recommended)
2219
bun create better-t-stack@latest
2320

2421
# Using pnpm
2522
pnpm create better-t-stack@latest
23+
24+
# Using npm
25+
npx create-better-t-stack@latest
2626
```
2727

2828
Follow the prompts to configure your project or use the `--yes` flag for defaults.
@@ -58,14 +58,15 @@ Options:
5858
--auth Include authentication
5959
--no-auth Exclude authentication
6060
--frontend <types...> Frontend types (tanstack-router, react-router, tanstack-start, next, nuxt, svelte, solid, native-nativewind, native-unistyles, none)
61-
--addons <types...> Additional addons (pwa, tauri, starlight, biome, husky, turborepo, none)
61+
--addons <types...> Additional addons (pwa, tauri, starlight, biome, husky, turborepo, fumadocs, ultracite, oxlint, none)
6262
--examples <types...> Examples to include (todo, ai, none)
6363
--git Initialize git repository
6464
--no-git Skip git initialization
6565
--package-manager <pm> Package manager (npm, pnpm, bun)
6666
--install Install dependencies
6767
--no-install Skip installing dependencies
68-
--db-setup <setup> Database setup (turso, d1, neon, supabase, prisma-postgres, mongodb-atlas, none)
68+
--db-setup <setup> Database setup (turso, d1, neon, supabase, prisma-postgres, mongodb-atlas, docker, none)
69+
--web-deploy <setup> Web deployment (workers, none)
6970
--backend <framework> Backend framework (hono, express, elysia, next, convex, fastify, none)
7071
--runtime <runtime> Runtime (bun, node, workers, none)
7172
--api <type> API type (trpc, orpc, none)
@@ -84,7 +85,7 @@ This CLI collects anonymous usage data to help improve the tool. The data collec
8485

8586
### Disabling Telemetry
8687

87-
You can disable telemetry by setting the `BTS_TELEMETRY` environment variable:
88+
You can disable telemetry by setting the `BTS_TELEMETRY_DISABLED` environment variable:
8889

8990
```bash
9091
# Disable telemetry for a single run
@@ -94,10 +95,6 @@ BTS_TELEMETRY_DISABLED=1 npx create-better-t-stack my-app
9495
export BTS_TELEMETRY_DISABLED=1
9596
```
9697

97-
### Development
98-
99-
During development, telemetry is automatically disabled when `NODE_ENV=development`.
100-
10198
## Examples
10299

103100
Create a project with default configuration:
@@ -118,10 +115,10 @@ Create a project with Elysia backend and Node.js runtime:
118115
npx create-better-t-stack my-app --backend elysia --runtime node
119116
```
120117

121-
Create a project with multiple frontend options:
118+
Create a project with multiple frontend options (one web + one native):
122119

123120
```bash
124-
npx create-better-t-stack my-app --frontend tanstack-router native
121+
npx create-better-t-stack my-app --frontend tanstack-router native-nativewind
125122
```
126123

127124
Create a project with examples:

apps/web/content/docs/analytics.mdx

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,26 @@ Not collected:
2323

2424
Telemetry is enabled by default. To disable:
2525

26-
```bash
27-
# Disable for a single run
28-
BTS_TELEMETRY_DISABLED=1 bun create better-t-stack@latest
29-
```
26+
<Tabs items={['bun', 'pnpm', 'npm']}>
27+
<Tab value="bun">
28+
```bash
29+
# Disable for a single run
30+
BTS_TELEMETRY_DISABLED=1 bun create better-t-stack@latest
31+
```
32+
</Tab>
33+
<Tab value="pnpm">
34+
```bash
35+
# Disable for a single run
36+
BTS_TELEMETRY_DISABLED=1 pnpm create better-t-stack@latest
37+
```
38+
</Tab>
39+
<Tab value="npm">
40+
```bash
41+
# Disable for a single run
42+
BTS_TELEMETRY_DISABLED=1 npx create-better-t-stack@latest
43+
```
44+
</Tab>
45+
</Tabs>
3046

3147
Add `export BTS_TELEMETRY_DISABLED=1` to your shell profile to make it permanent.
3248

0 commit comments

Comments
 (0)