From 44a89e3e75fa5b33cb93d13e3424e01ab43e13d9 Mon Sep 17 00:00:00 2001 From: Chris Johnson <49479599+workeffortwaste@users.noreply.github.com> Date: Thu, 10 Feb 2022 15:25:02 +0000 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 27b162c..7876658 100644 --- a/README.md +++ b/README.md @@ -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.