diff --git a/README.md b/README.md index 5bd5415..cf5c632 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Install pnpm package manager. Version of pnpm to install. -**Optional** when there is a [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html). +**Optional** when there is a [`packageManager` or `devEngines.packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html). otherwise, this field is **required** It supports npm versioning scheme, it could be an exact version (such as `10.9.8`), or a version range (such as `10`, `10.x.x`, `10.9.x`, `^10.9.8`, `*`, etc.), or `latest`. @@ -52,7 +52,7 @@ If `run_install` is a YAML string representation of either an object or an array ### `package_json_file` -**Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json`/[`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) to read "packageManager" configuration. +**Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json`/[`package.yaml`](https://github.com/pnpm/pnpm/pull/1799) to read `packageManager` or `devEngines.packageManager` configuration. ### `standalone` @@ -74,7 +74,7 @@ Location of `pnpm` and `pnpx` command. ### Install only pnpm without `packageManager` -This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager`. +This works when the repo either doesn't have a `package.json` or has a `package.json` but it doesn't specify `packageManager` or `devEngines.packageManager`. ```yaml on: @@ -93,7 +93,7 @@ jobs: ### Install only pnpm with `packageManager` -Omit `version` input to use the version in the [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html). +Omit `version` input to use the version in the [`packageManager` or `devEngines.packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html). ```yaml on: