Skip to content

Commit f62b0f6

Browse files
docs: clarify Options.md from Bingo updates
1 parent 792c9d9 commit f62b0f6

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/Options.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ These options can only be inferred when running on an existing repository.
3030
Each will be prompted for when creating a new repository if not explicitly provided:
3131

3232
- `--description` _(`string`)_: 'Sentence case.' description of the repository
33-
- `--title` _(`string`)_: 'Title Case' title for the repository
33+
- `--directory` _(`string`)_: which directory and repository name to use
3434

35-
For example, pre-populating both required base options:
35+
For example, pre-populating all required base options:
3636

3737
```shell
38-
npx create-typescript-app@beta --description "My awesome TypeScript app! 💖" --title "My TypeScript App"
38+
npx create-typescript-app@beta --directory my-typescript-app --description "My awesome TypeScript app! 💖" --preset everything
3939
```
4040

4141
That script will run completely autonomously, no prompted inputs required. ✨
@@ -48,11 +48,12 @@ They will be inferred from the running user, and if migrating an existing reposi
4848
- `--access` _(`"public" | "restricted"`)_: Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with (by default, `"public"`)
4949
- `--author` _(`string`)_: Username on npm to publish packages under (by default, an existing npm author, or the currently logged in npm user, or `owner.toLowerCase()`)
5050
- `--bin` _(`string`)_: Value to set in `package.json`'s `"bin"` property, per [FAQs > How can I use `bin`?](./FAQs.md#how-can-i-use-bin)
51-
- `--directory` _(`string`)_: Directory to create the repository in (by default, the same name as the repository)
51+
- `--repository` _(`string`)_: Name for the new repository (by default, the same as `--directory`)
5252
- `--email` _(`string`)_: Email address to be listed as the point of contact in docs and packages (e.g. `[email protected]`)
5353
- `--funding` _(`string`)_: GitHub organization or username to mention in `funding.yml` (by default, `owner`)
5454
- `--keywords` _(`string[]`)_: Any number of keywords to include in `package.json` (by default, none)
5555
- This can be specified any number of times, like `--keywords apple --keywords "banana cherry"`
56+
- `--title` _(`string`)_: 'Title Case' title for the repository (by default, based on the repository name)
5657

5758
For example, customizing the npm author and funding source:
5859

@@ -62,9 +63,6 @@ npx create-typescript-app@beta --author my-npm-username --funding MyGitHubOrgani
6263

6364
## Block Exclusions
6465

65-
> TODO: This is not implemented yet!
66-
> <https://github.com/JoshuaKGoldberg/bingo/issues/215>
67-
6866
Per [Bingo > Stratum > Configurations > `blocks`](https://www.create.bingo/engines/stratum/details/configurations#blocks), individual Blocks may be excluded from running.
6967
For example, initializing with all tooling except for Renovate:
7068

0 commit comments

Comments
 (0)