Skip to content

Commit 034ec8f

Browse files
mashabekpavelsvagr
authored andcommitted
✨ Update Readme usage instructions to include options for directory and project name
1 parent 098133a commit 034ec8f

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,14 @@ CLI to help you set up Node.js TypeScript project. Set up project includes
1818
Run directly from GitHub repo via npx:
1919

2020
```
21-
Usage: npm exec --ignore-scripts -- github:AckeeCZ/create-node-app STARTER [DIRECTORY]
21+
Usage: npm exec --ignore-scripts -- github:AckeeCZ/create-node-app STARTER [OPTIONS] [DIRECTORY]
2222
23-
STARTER Which template to setup
24-
DIRECTORY Destination directory where to set the starter up (default: ./node-app)
25-
PROJECT_NAME (optional) Name of the project - used in .env files
23+
STARTER Which template to setup (required)
24+
25+
Options:
26+
--dir, -d DIR Destination directory (default: ./node-app)
27+
--name, -n NAME Project name used in config files (default: directory basename)
28+
--help, -h Show this help message
2629
2730
Starters available:
2831
cloudrun Cloud Run + express

0 commit comments

Comments
 (0)