Skip to content

Commit 933c53a

Browse files
docs: describe the setup script more in README.md (#299)
1 parent 29f1602 commit 933c53a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ It sets up the following tooling for you:
4545

4646
## Setup
4747

48+
This package comes with a bootstrap/initialization setup script that fills out your repository's details, installs necessary packages, then removes itself and uninstalls setup dependencies.
49+
4850
First make sure you have the following installed:
4951

5052
- [GitHub CLI](https://cli.github.com) _(you'll need to be logged in)_
@@ -59,7 +61,7 @@ To use this template:
5961
- `ACCESS_TOKEN`: A [GitHub PAT](https://github.com/settings/tokens/new) with _repo_ permissions
6062
- `NPM_TOKEN`: An [npm access token](https://docs.npmjs.com/creating-and-viewing-access-tokens/) with _Automation_ permissions
6163
4. `pnpm install`
62-
5. `pnpm run setup`
64+
5. `pnpm run setup` to run the setup script
6365
6. Install the [Codecov GitHub App](https://github.com/marketplace/codecov) and [Renovate GitHub App](https://github.com/marketplace/renovate)
6466

6567
> The setup script removes the `## Explainer` and `## Setup` from this README.md.

0 commit comments

Comments
 (0)