From 6aacd7c4d042df55ac1f5b705de58f03c558eb7a Mon Sep 17 00:00:00 2001 From: Gabriel Simmer Date: Sat, 3 Aug 2024 23:10:48 +0100 Subject: [PATCH] Update README with new snapshot.sh --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3454cf9..4548e22 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,24 @@ About Various tools for rendering and sharing snapshots of websites using Servo, primarily to track [my own site](https://servo.arch.dog) over time. -`main.py` is a wrapper around Docker for rendering a screenshot then producing a hash of the image. This can help +`snapshot.sh` is a wrapper around Docker for rendering a screenshot then producing a hash of the image. This can help indicate when Servo's rendering has changed. If you get inconsistant results with the same version and site, see [this GitHub issue](https://github.com/servo/servo/issues/32771). `worker/` is a small Cloudflare Worker for collecting and serving the images. Currently requires manual uploading. +snapshot.sh +--- + +Generating snapshots is easy but requires a few commands to be run in sequence. `snapshot.sh` wraps: + +* Pulling the latest container image +* Running the container image with a volume mount to produce a snapshot +* Hashing the image +* Uploading the image to a Worker endpoint (see below) + +Uploading the image is optional, provided `--dry-run` is passed. + Worker ---