Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
workeffortwaste committed Feb 10, 2022
1 parent f22fa20 commit 44a89e3
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ This will generate an animated `layout-shift.gif` of `https://blacklivesmatter.c
#### Options


| Option              | Alias | Default | Description |
| Option | Alias | Default | Description |
|-----------|-------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| --url | -u | | **(Required)** The URL of the page you want to generate a Layout Shift GIF from. |
| --output | -o | layout-shift.gif | The output filename for the final .gif. |
| --device | -d | mobile | The type of the device you wish to simulate. |
| --width | -w | (412\|1920) | Override the device viewport width. |
| --height | -h | (732\|1080) | Override the device viewport height |
| --cookies | -c | | Supply a cookie file in the Puppeteer JSON format. I recommend using this Chrome Extension to export your cookies. [Export cookie JSON file for Puppeteer](https://chrome.google.com/webstore/detail/%E3%82%AF%E3%83%83%E3%82%AD%E3%83%BCjson%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E5%87%BA%E5%8A%9B-for-puppet/nmckokihipjgplolmcmjakknndddifde?hl=en) |
| --type | -t | new | The method of calcuating the the layout shift. |
| url | -u | | **(Required)** The URL of the page you want to generate a Layout Shift GIF from. |
| output | -o | layout-shift.gif | The output filename for the final .gif. |
| device | -d | mobile | The type of the device you wish to simulate. |
| width | -w | (412\|1920) | Override the device viewport width. |
| height | -h | (732\|1080) | Override the device viewport height |
| cookies | -c | | Supply a cookie file in the Puppeteer JSON format. I recommend using this Chrome Extension to export your cookies. [Export cookie JSON file for Puppeteer](https://chrome.google.com/webstore/detail/%E3%82%AF%E3%83%83%E3%82%AD%E3%83%BCjson%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E5%87%BA%E5%8A%9B-for-puppet/nmckokihipjgplolmcmjakknndddifde?hl=en) |
| type | -t | new | The method of calcuating the the layout shift. |
### Device Simulation

The tool is able to check both a desktop and a mobile viewport.
Expand Down

0 comments on commit 44a89e3

Please sign in to comment.