From a2efce8b27fcda8533c6c912ee7e0b72374cda85 Mon Sep 17 00:00:00 2001 From: mgiovani Date: Wed, 1 Jul 2026 17:21:49 -0300 Subject: [PATCH] docs: fix inaccurate write-mode descriptions in README Live-tested each upload write mode against a real PR: --print-only still creates a git blob/commit/ref (only the comment/body step is skipped), and --update-comment replaces the comment body rather than appending to it. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46af211..258b5f2 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ The extension auto-selects the matching prebuilt binary for your host OS and arc ### Upload images ```sh -# Print markdown image links only (default, no GitHub write) +# Print markdown image links only (default; still uploads to a git ref, just skips posting/editing) gh agent-screenshot upload a.png b.png --repo owner/name --issue 1 --print-only # Post images as a new comment gh agent-screenshot upload a.png b.png --repo owner/name --issue 1 --new-comment -# Append images to an existing comment +# Replace an existing comment's content with these images gh agent-screenshot upload a.png b.png --repo owner/name --issue 1 --update-comment # Embed images in the issue/PR body