Skip to content

Commit 96bdb93

Browse files
docs: mostly finish updating from create to Bingo
1 parent cec96c0 commit 96bdb93

File tree

7 files changed

+21
-21
lines changed

7 files changed

+21
-21
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ First make sure you have the following installed:
3838
Then in an existing repository or in your directory where you'd like to make a new repository:
3939

4040
```shell
41-
npx create typescript-app@beta
41+
npx bingo typescript-app@beta
4242
```
4343

44-
That will launch `create-typescript-app` using the [`create` runner](https://create.bingo).
44+
That will launch `create-typescript-app` using the [`bingo` runner](https://create.bingo).
4545

4646
You can read more about the supported setup modes in their docs pages:
4747

bin/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ console.log(
66
"create-typescript-app is now run using ",
77
chalk.bold("bingo"),
88
".\n\nRun:\n ",
9-
chalk.bold("npx create", process.argv.slice(2).join(" ")),
9+
chalk.bold("npx bingo", process.argv.slice(2).join(" ")),
1010
"\n\nYou can read more on:\n https://",
1111
chalk.bold("create.bingo"),
1212
"\n\nThanks for using create-typescript-app! 🎁",

docs/Creation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Creating from the Terminal
22

3-
You can run `npx create typescript-app@beta` in your terminal to interactively create a new repository:
3+
You can run `npx bingo typescript-app@beta` in your terminal to interactively create a new repository:
44

55
```shell
6-
npx create typescript-app@beta
6+
npx bingo typescript-app@beta
77
```
88

99
The creation script will by default:
@@ -34,7 +34,7 @@ See [Options.md](./Options.md).
3434
For example, skipping the _"This package was templated with..."_ block:
3535

3636
```shell
37-
npx create typescript-app@beta --mode create --exclude-templated-with
37+
npx bingo typescript-app@beta --mode create --exclude-templated-with
3838
```
3939

4040
See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in.

docs/Initialization.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Initializing from the Template
22

3-
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.
3+
As an alternative to [creating with `npx bingo 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.
44
You can set up the new repository locally by cloning it and installing packages:
55

66
```shell
77
git clone https://github.com/YourUsername/YourRepositoryName
88
cd YourRepositoryName
9-
npx create typescript-app@beta
9+
npx bingo typescript-app@beta
1010
```
1111

1212
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).
2929
For example, skipping the _"This package was templated with..."_ block:
3030

3131
```shell
32-
npx create typescript-app@beta --exclude-templated-with
32+
npx bingo typescript-app@beta --exclude-templated-with
3333
```
3434

3535
See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in.

docs/Migration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Migrating an Existing Repository
22

3-
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.
3+
If you have an existing repository that you'd like to give the files from this repository, you can run `npx bingo typescript-app@beta` in it to "migrate" its tooling to this template's.
44

55
```shell
6-
npx create typescript-app@beta
6+
npx bingo typescript-app@beta
77
```
88

99
The migration script will:
@@ -46,7 +46,7 @@ See [Options.md](./Options.md).
4646
For example, skipping the _"This package was templated with..."_ block:
4747

4848
```shell
49-
npx create typescript-app@beta --exclude-templated-with
49+
npx bingo typescript-app@beta --exclude-templated-with
5050
```
5151

5252
See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in.

docs/Options.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Options
22

3-
`create-typescript-app` is built on top of [`create`](https://create.bingo).
4-
`npx create typescript-app@beta` supports all the flags defined by the [`create` CLI](https://www.create.bingo/cli).
3+
`create-typescript-app` is built on top of [Bingo](https://create.bingo).
4+
`npx bingo typescript-app@beta` supports all the flags defined by the [`bingo` CLI](https://www.create.bingo/cli).
55
It provides three Presets:
66

77
1. **Minimal**: Just bare starter tooling: building, formatting, linting, and type checking.
@@ -11,7 +11,7 @@ It provides three Presets:
1111
For example, to create a new repository on the _everything_ preset:
1212

1313
```shell
14-
npx create typescript-app@beta --preset everything
14+
npx bingo typescript-app@beta --preset everything
1515
```
1616

1717
`create-typescript-app` itself adds in two sections of flags:
@@ -21,7 +21,7 @@ npx create typescript-app@beta --preset everything
2121

2222
## Base Options
2323

24-
Per [`create` > CLI > Template Options](https://www.create.bingo/cli#template-options), options defined by `create-typescript-app` may be provided on the CLI.
24+
Per [Bingo > CLI > Template Options](https://www.create.bingo/cli#template-options), options defined by `create-typescript-app` may be provided on the CLI.
2525

2626
### Required Base Options
2727

@@ -34,7 +34,7 @@ Each will be prompted for when creating a new repository if not explicitly provi
3434
For example, pre-populating both required base options:
3535

3636
```shell
37-
npx create typescript-app@beta --description "My awesome TypeScript app! 💖" --title "My TypeScript App"
37+
npx bingo typescript-app@beta --description "My awesome TypeScript app! 💖" --title "My TypeScript App"
3838
```
3939

4040
That script will run completely autonomously, no prompted inputs required. ✨
@@ -56,16 +56,16 @@ They will be inferred from the running user, and if migrating an existing reposi
5656
For example, customizing the npm author and funding source:
5757

5858
```shell
59-
npx create typescript-app@beta --author my-npm-username --funding MyGitHubOrganization
59+
npx bingo typescript-app@beta --author my-npm-username --funding MyGitHubOrganization
6060
```
6161

6262
## Block Exclusions
6363

64-
Per [`create` > CLI > Template Options > Block Exclusions](https://www.create.bingo/cli#block-exclusions), individual Blocks may be excluded from running.
64+
Per [Bingo > Stratum > Configurations > `blocks`](https://www.create.bingo/engines/stratum/details/configurations#blocks), individual Blocks may be excluded from running.
6565
For example, initializing with all tooling except for Renovate:
6666

6767
```shell
68-
npx create typescript-app@beta --exclude-renovate
68+
npx bingo typescript-app@beta --exclude-renovate
6969
```
7070

7171
See [Blocks.md](./Blocks.md) for the list of blocks and their corresponding presets.

src/integration.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {
1818
presets,
1919
} from "./index.js";
2020

21-
// This test checks the `create` production using options inferred from disk,
21+
// This test checks the Bingo production using options inferred from disk,
2222
// along with some explicit addons and blocks specified.
2323
// It ensures that result has no differences from the actual files on disk.
2424
//

0 commit comments

Comments
 (0)