Merge pull request #7 from CarGDev/codex/update-readme-with-package-flags

Add CLI flags documentation and help file
This commit is contained in:
CarGDev
2025-07-01 22:42:54 -04:00
committed by GitHub
2 changed files with 18 additions and 0 deletions

9
HELP.md Normal file
View File

@@ -0,0 +1,9 @@
# React Crafter CLI Help
Usage:
npx react-crafter <project-directory> [options]
Options:
--typescript Scaffold the project using the TypeScript template
-V, --version Output the version number
-h, --help Display help information

View File

@@ -49,6 +49,15 @@ npx react-crafter awesome-project
During setup you'll select either JavaScript or TypeScript. React Crafter then calls `create-vite` with the matching template (`react` or `react-ts`) so you won't see any additional prompts.
## CLI Flags
React Crafter supports a few command line options:
- `--typescript` scaffold the project using the TypeScript template without a prompt.
- `-V, --version` output the CLI version.
- `-h, --help` display usage information.
## Commands
Heres a summary of the commands you can use after setting up your project: