diff options
| author |  Drew Powers <1369770+drwpow@users.noreply.github.com>
| 2021-06-10 10:30:48 -0600 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-06-10 10:30:48 -0600 |
| commit | a660e49f80accbc4e18f48cc10bf23a239f711fe (patch) | |
| tree | 7f6652556315008cef020dd3ef4ef3c298a2da13 /packages/create-astro/README.md | |
| parent | 047b0fcc6cbe722fd0f3d8ca7894e7986f004302 (diff) | |
| download | astro-a660e49f80accbc4e18f48cc10bf23a239f711fe.tar.gz astro-a660e49f80accbc4e18f48cc10bf23a239f711fe.tar.zst astro-a660e49f80accbc4e18f48cc10bf23a239f711fe.zip | |
Add integration test for templates (#372)
Diffstat (limited to 'packages/create-astro/README.md')
| -rw-r--r-- | packages/create-astro/README.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/packages/create-astro/README.md b/packages/create-astro/README.md index 0c3982ed5..4a90b7eb4 100644 --- a/packages/create-astro/README.md +++ b/packages/create-astro/README.md @@ -26,5 +26,15 @@ npm init astro my-astro-project -- --template starter # yarn yarn create astro my-astro-project --template starter ``` +[Check out the full list][examples] of example starter templates, available on GitHub. -[Check out the full list](https://github.com/snowpackjs/astro/tree/main/examples) of example starter templates, available on GitHub. +### CLI Flags + +May be provided in place of prompts + +| Name | Description | +|:-------------|:----------------------------------------------------| +| `--template` | Specify the template name ([list][examples]) | +| `--commit` | Specify a specific Git commit or branch to use from this repo (by default, `main` branch of this repo will be used) | + +[examples]: https://github.com/snowpackjs/astro/tree/main/examples |