Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update install instructions to use pnpm and remove skip-npm #285

Merged
merged 1 commit into from
Apr 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The blueprint contains a number of assumptions, e.g. using a monorepo using (`ya
## Usage

```bash
ember addon my-addon -b @embroider/addon-blueprint --yarn
ember addon my-addon -b @embroider/addon-blueprint --pnpm
```

### Options
Expand All @@ -26,27 +26,23 @@ For all these options, you'll see a warning printed from `ember-cli` about unsup
#### `--pnpm`

Sets up the new addon with [`pnpm`](https://pnpm.io/) as a default package manager.
Note, that because `ember-cli` doesn't support this flag, you'll need to also add `--skip-npm` (which skips install).

Example:

```bash
ember addon my-addon -b @embroider/addon-blueprint --pnpm --skip-npm
ember addon my-addon -b @embroider/addon-blueprint --pnpm
cd my-addon
pnpm install
```

#### `--npm`

Sets up the new addon with `npm` as a default.
Note, that because `ember-cli` doesn't support this flag, you'll need to also add `--skip-npm` (which skips install).

Example:

```bash
ember addon my-addon -b @embroider/addon-blueprint --npm --skip-npm
ember addon my-addon -b @embroider/addon-blueprint --npm
cd my-addon
npm install
```

#### `--yarn`
Expand All @@ -58,7 +54,6 @@ Example:
```bash
ember addon my-addon -b @embroider/addon-blueprint --yarn
cd my-addon
yarn install
```

#### `--addon-location`
Expand Down
Loading