From 3f61348a195b5c0567808ebd17c0215c50b8fe05 Mon Sep 17 00:00:00 2001 From: Danil Silantyev Date: Sat, 4 Jul 2026 12:27:52 +0700 Subject: [PATCH] =?UTF-8?q?docs(readme):=20fix=20Library=20use=20example?= =?UTF-8?q?=20=E2=80=94=20package=20name=20and=20renderTextToImages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The 'Library use' snippet imported `renderTextToPngs` from "pxpipe", but the published package is "pxpipe-proxy" and the root barrel (src/core/index.ts) exports `renderTextToImages`, not `renderTextToPngs`. Both the import specifier and the function name were unrunnable as written. - import from "pxpipe-proxy" (matches package.json "name") - use renderTextToImages, which returns { pages, droppedChars, pixels } - show pages[i].png (Uint8Array) instead of the stale RenderedImage[] comment --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 47876e1..c3407ee 100644 --- a/README.md +++ b/README.md @@ -117,9 +117,9 @@ sparse prose stays text. Events log to `~/.pxpipe/events.jsonl`. ## Library use (no proxy) ```ts -import { renderTextToPngs, transformAnthropicMessages } from "pxpipe"; +import { renderTextToImages, transformAnthropicMessages } from "pxpipe-proxy"; -const imgs = await renderTextToPngs(toolResultText); // RenderedImage[] +const { pages } = await renderTextToImages(toolResultText); // pages[i].png: Uint8Array const { body, applied, info } = await transformAnthropicMessages({ body: requestBytes, model: "claude-fable-5",