create-better-t-stack 2.25.2 → 2.25.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -66,6 +66,32 @@ Options:
66
66
  -h, --help Display help
67
67
  ```
68
68
 
69
+ ## Telemetry
70
+
71
+ This CLI collects anonymous usage data to help improve the tool. The data collected includes:
72
+ - Configuration options selected
73
+ - CLI version
74
+ - Node.js version
75
+ - Platform (OS)
76
+
77
+ **Telemetry is enabled by default in published versions** to help us understand usage patterns and improve the tool.
78
+
79
+ ### Disabling Telemetry
80
+
81
+ You can disable telemetry by setting the `BTS_TELEMETRY` environment variable:
82
+
83
+ ```bash
84
+ # Disable telemetry for a single run
85
+ BTS_TELEMETRY=0 npx create-better-t-stack my-app
86
+
87
+ # Disable telemetry globally in your shell profile (.bashrc, .zshrc, etc.)
88
+ export BTS_TELEMETRY=0
89
+ ```
90
+
91
+ ### Development
92
+
93
+ During development, telemetry is automatically disabled when `NODE_ENV=development`.
94
+
69
95
  ## Examples
70
96
 
71
97
  Create a project with default configuration: