2 Commits
Author SHA1 Message Date
Gregory RichardandClaude Opus 5 e575bdabf4 docs: rewrite the documentation, add screenshots and a wiki
The README documented five of the seven nodes - Save Image (Civitai) and
Prompt + LoRAs, the two largest features, appeared nowhere - and what it
did document, it documented in prose. It is now compact and built to be
scanned: what the pack does, three screenshots, install, the node table,
and links out.

Everything longer moved into wiki/: Home, Usage, Nodes, API,
Architecture, Development and Troubleshooting. Nodes.md was generated
from the real schemas and API.md was diffed field by field against a
running server, so neither describes a version of the code that does not
exist.

The Civitai Updater relationship is written down properly, as a table of
which sidecar field feeds which feature and what stops working without
one. Only the AutoV2 hash has a fallback, which is worth saying plainly.

A workflow publishes wiki/ to the repository's GitHub wiki, rewriting
repo-relative image and file links so they resolve there. The wiki repo
has to be created once in the web UI before the first run.

Screenshots are captured from a real ComfyUI running this branch, driven
with Playwright at 2x against a generated demo LoRA folder - illustrative
names and stand-in preview art, never a real collection. Six shots, 352 KB
as WebP.

Assets restructured to match the sibling civitai-updater project:
registry art sized and quantised (the banner from 4.8 MB to 487 KB at
exactly 21:9), screenshots in assets/docs/, originals kept in
assets/source/. pyproject's registry URLs follow the moved files.

The example workflow is now two model configurations, Krea 2 and Z-Image
Turbo, each with its own Warp, switched into one shared pipeline. Its
output image carries both the workflow and the Civitai parameters block
it was saved with.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-01 21:47:25 +02:00
Gregory RichardandCursor 0cbe289539 Add pixel art banner, example workflow, and highlight key advantages in README
Added 8-bit pixel art banner (chaos-in, beauty-out horizontal warp pipe). Regenerated icon. Moved workflow example files to examples/ directory. Added 'Why WarpPipe?' section highlighting clean workflows, fast model switching, and modular flexibility. Added banner URL to pyproject.toml. Bumped to v3.0.2.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-09 23:44:34 +01:00