create-astro 2.0.2 → 3.0.1

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
@@ -18,15 +18,15 @@ yarn create astro
18
18
 
19
19
  ```bash
20
20
  # npm 6.x
21
- npm create astro@latest my-astro-project --template starter
21
+ npm create astro@latest my-astro-project --template minimal
22
22
 
23
23
  # npm 7+, extra double-dash is needed:
24
- npm create astro@latest my-astro-project -- --template starter
24
+ npm create astro@latest my-astro-project -- --template minimal
25
25
 
26
26
  # yarn
27
- yarn create astro my-astro-project --template starter
27
+ yarn create astro my-astro-project --template minimal
28
28
  ```
29
- [Check out the full list][examples] of example starter templates, available on GitHub.
29
+ [Check out the full list][examples] of example templates, available on GitHub.
30
30
 
31
31
  You can also use any GitHub repo as a template:
32
32
 
@@ -40,26 +40,13 @@ May be provided in place of prompts
40
40
 
41
41
  | Name | Description |
42
42
  |:-------------|:----------------------------------------------------|
43
- | `--template` | Specify the template name ([list][examples]) |
44
- | `--commit` | Specify a specific Git commit or branch to use from this repo (by default, `main` branch of this repo will be used) |
45
- | `--fancy` | For Windows users, `--fancy` will enable full unicode support |
46
- | `--typescript` | Specify the [tsconfig][typescript] to use |
47
- | `--yes`/`-y` | Skip prompts and use default values |
48
-
49
- ### Debugging
50
-
51
- To debug `create-astro`, you can use the `--verbose` flag which will log the output of degit and some more information about the command, this can be useful when you encounter an error and want to report it.
52
-
53
- ```bash
54
- # npm 6.x
55
- npm create astro@latest my-astro-project --verbose
56
-
57
- # npm 7+, extra double-dash is needed:
58
- npm create astro@latest my-astro-project -- --verbose
59
-
60
- # yarn
61
- yarn create astro my-astro-project --verbose
62
- ```
43
+ | `--template <name> | Specify your template. |
44
+ | `--install / --no-install | Install dependencies (or not). |
45
+ | `--git / --no-git | Initialize git repo (or not). |
46
+ | `--yes (-y) | Skip all prompt by accepting defaults. |
47
+ | `--no (-n) | Skip all prompt by declining defaults. |
48
+ | `--dry-run | Walk through steps without executing. |
49
+ | `--skip-houston | Skip Houston animation. |
63
50
 
64
51
  [examples]: https://github.com/withastro/astro/tree/main/examples
65
52
  [typescript]: https://github.com/withastro/astro/tree/main/packages/astro/tsconfigs