diff --git a/README.md b/README.md index cb7690d91..a852a7c2f 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,10 @@ It includes options not just for building and testing but also automated release ## Usage +> **Note:** create-typescript-app is preparing to promote 2.0 beta version to stable soon. +> The repository's `main` branch shows commands for the `beta` version. +> The published package's 1.x versions still show commands for the 1.x version. + First make sure you have the following installed: - [Node.js](https://nodejs.org) @@ -34,7 +38,7 @@ First make sure you have the following installed: Then in an existing repository or in your directory where you'd like to make a new repository: ```shell -npx create typescript-app +npx create typescript-app@beta ``` That will launch `create-typescript-app` using the [`create` runner](https://create.bingo). diff --git a/docs/Creation.md b/docs/Creation.md index 1fa7bfd06..884dd5bd8 100644 --- a/docs/Creation.md +++ b/docs/Creation.md @@ -1,9 +1,9 @@ # Creating from the Terminal -You can run `npx create typescript-app` in your terminal to interactively create a new repository: +You can run `npx create typescript-app@beta` in your terminal to interactively create a new repository: ```shell -npx create typescript-app +npx create typescript-app@beta ``` The creation script will by default: @@ -34,7 +34,7 @@ See [Options.md](./Options.md). For example, skipping the _"This package was templated with..."_ block: ```shell -npx create typescript-app --mode create --exclude-templated-with +npx create typescript-app@beta --mode create --exclude-templated-with ``` See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in. diff --git a/docs/Initialization.md b/docs/Initialization.md index 2164c75bb..e9ca9ffd4 100644 --- a/docs/Initialization.md +++ b/docs/Initialization.md @@ -1,12 +1,12 @@ # Initializing from the Template -As an alternative to [creating with `npx create typescript-app`](./Creation.md), the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub can be used to quickly create a new repository from the template. +As an alternative to [creating with `npx create typescript-app@beta`](./Creation.md), the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub can be used to quickly create a new repository from the template. You can set up the new repository locally by cloning it and installing packages: ```shell git clone https://github.com/YourUsername/YourRepositoryName cd YourRepositoryName -npx create typescript-app +npx create typescript-app@beta ``` You'll then need to manually go through the following two steps to set up tooling on GitHub: @@ -29,7 +29,7 @@ See [Options.md](./Options.md). For example, skipping the _"This package was templated with..."_ block: ```shell -npx create typescript-app --exclude-templated-with +npx create typescript-app@beta --exclude-templated-with ``` See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in. diff --git a/docs/Migration.md b/docs/Migration.md index 0fa226b46..94515baee 100644 --- a/docs/Migration.md +++ b/docs/Migration.md @@ -1,9 +1,9 @@ # Migrating an Existing Repository -If you have an existing repository that you'd like to give the files from this repository, you can run `npx create typescript-app` in it to "migrate" its tooling to this template's. +If you have an existing repository that you'd like to give the files from this repository, you can run `npx create typescript-app@beta` in it to "migrate" its tooling to this template's. ```shell -npx create typescript-app +npx create typescript-app@beta ``` The migration script will: @@ -46,7 +46,7 @@ See [Options.md](./Options.md). For example, skipping the _"This package was templated with..."_ block: ```shell -npx create typescript-app --exclude-templated-with +npx create typescript-app@beta --exclude-templated-with ``` See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in. diff --git a/docs/Options.md b/docs/Options.md index 803c85147..72c42b6da 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -1,7 +1,7 @@ # Options `create-typescript-app` is built on top of [`create`](https://create.bingo). -`npx create typescript-app` supports all the flags defined by the [`create` CLI](https://www.create.bingo/cli). +`npx create typescript-app@beta` supports all the flags defined by the [`create` CLI](https://www.create.bingo/cli). It provides three Presets: 1. **Minimal**: Just bare starter tooling: building, formatting, linting, and type checking. @@ -11,7 +11,7 @@ It provides three Presets: For example, to create a new repository on the _everything_ preset: ```shell -npx create typescript-app --preset everything +npx create typescript-app@beta --preset everything ``` `create-typescript-app` itself adds in two sections of flags: @@ -34,7 +34,7 @@ Each will be prompted for when creating a new repository if not explicitly provi For example, pre-populating both required base options: ```shell -npx create typescript-app --description "My awesome TypeScript app! 💖" --title "My TypeScript App" +npx create typescript-app@beta --description "My awesome TypeScript app! 💖" --title "My TypeScript App" ``` That script will run completely autonomously, no prompted inputs required. ✨ @@ -56,7 +56,7 @@ They will be inferred from the running user, and if migrating an existing reposi For example, customizing the npm author and funding source: ```shell -npx create typescript-app --author my-npm-username --funding MyGitHubOrganization +npx create typescript-app@beta --author my-npm-username --funding MyGitHubOrganization ``` ## Block Exclusions @@ -65,7 +65,7 @@ Per [`create` > CLI > Template Options > Block Exclusions](https://www.create.bi For example, initializing with all tooling except for Renovate: ```shell -npx create typescript-app --exclude-renovate +npx create typescript-app@beta --exclude-renovate ``` See [Blocks.md](./Blocks.md) for the list of blocks and their corresponding presets.