z0rs
/
chromium
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more -min documentation

This commit is contained in:
Sparticuz 2023-01-13 16:04:06 -05:00
parent 12764483af
commit 0270285a4a
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/release.yml vendored
View File

@ -41,7 +41,9 @@ jobs:
run: | run: |
jq '.name="@sparticuz/chromium-min"' package.json > .package.json jq '.name="@sparticuz/chromium-min"' package.json > .package.json
jq 'del(.files[] | select(. == "bin"))' .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 npm install
- name: Release chromium-min on npmjs - name: Release chromium-min on npmjs

7
README.md
View File

@ -25,10 +25,15 @@ In order to figure out what version of `@sparticuz/chromium` you will need, plea
```shell ```shell
# Puppeteer or Playwright is a production dependency # Puppeteer or Playwright is a production dependency
npm install --save puppeteer-core@$PUPPETEER_VERSION 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 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). 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 ## Versioning