diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 168f8f2..6ee9944 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -41,7 +41,9 @@ jobs: run: | jq '.name="@sparticuz/chromium-min"' package.json > .package.json jq 'del(.files[] | select(. == "bin"))' .package.json > package.json - rm package-lock.json .package.json + jq '.homepage="https://github.com/Sparticuz/chromium#-min-package"' package.json > .package.json + mv .package.json package.json + rm package-lock.json npm install - name: Release chromium-min on npmjs diff --git a/README.md b/README.md index a1e30a3..a084782 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,15 @@ In order to figure out what version of `@sparticuz/chromium` you will need, plea ```shell # Puppeteer or Playwright is a production dependency npm install --save puppeteer-core@$PUPPETEER_VERSION -# @sparticuz/chromium is a DEV dependency IF YOU ARE USING A LAYER, if not, use as a production dependency! +# @sparticuz/chromium can be a DEV dependency IF YOU ARE USING A LAYER, if you are not using a layer, use as a production dependency! npm install --save-dev @sparticuz/chromium@$CHROMIUM_VERSION ``` +If your vendor does not allow large deploys (`chromium.br` is 50+ MB), you'll need to host the `chromium-v#-pack.tar` separatly and use the [`@sparticuz/chromium-min` package](https://github.com/Sparticuz/chromium#-min-package). +```shell +npm install --save @sparticuz/chromium-min@$CHROMIUM_VERSION +``` + If you wish to install an older version of Chromium, take a look at [@sparticuz/chrome-aws-lambda](https://github.com/Sparticuz/chrome-aws-lambda#versioning) or [@alixaxel/chrome-aws-lambda](https://github.com/alixaxel/chrome-aws-lambda). ## Versioning