Skip to content

docs: add Provenant-vs-ScanCode race demo to README#1224

Merged
mstykow merged 1 commit into
mainfrom
docs/readme-scan-demo
Jul 4, 2026
Merged

docs: add Provenant-vs-ScanCode race demo to README#1224
mstykow merged 1 commit into
mainfrom
docs/readme-scan-demo

Conversation

@mstykow

@mstykow mstykow commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add an animated side-by-side race GIF near the top of the README: Provenant and ScanCode scanning the same astral-sh/uv repository with identical flags (--license --package), one process each. Provenant finishes in ~6s (139 packages, 0 errors, compact summary) while ScanCode is still in early scan.
  • Check in the reproducible docs/demo.tape (vhs, tmux two-pane layout) with documented prerequisites, including how the ScanCode Docker image is built via compare-outputs.
  • Lightly de-hedge the project-status callout. No version numbers or exact benchmark averages added to the root README.

Issues

  • Covers: README first-impression / discoverability; proves the speed claim visually rather than asserting it.
  • Closes:

Scope and exclusions

  • Included: README race GIF + caption, reproducible vhs tape, status-callout wording.
  • Explicit exclusions: no code, CLI, or output-schema changes; no benchmark data changes.

How to verify

  • Open the rendered README; confirm the two-pane GIF displays (ScanCode left, Provenant right) and the caption reads correctly.
  • To regenerate, see the prerequisites documented at the top of docs/demo.tape, then vhs docs/demo.tape from the repo root.

Intentional differences from Python

  • N/A

Follow-up work

@greptile-apps

greptile-apps Bot commented Jul 4, 2026

Copy link
Copy Markdown

Greptile Summary

This PR adds a README race demo for Provenant and ScanCode. The main changes are:

  • A new side-by-side GIF in the README.
  • Updated project status wording near the top of the README.
  • A reproducible VHS tape for regenerating the demo.

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

Filename Overview
README.md Adds the race GIF and updates the nearby status copy.
docs/demo.tape Adds the reproducible demo recording workflow under the ignored scratch area.
docs/provenant-demo.gif Adds the generated animation used by the README.

Reviews (9): Last reviewed commit: "docs: add Provenant-vs-ScanCode race dem..." | Re-trigger Greptile

Comment thread docs/demo.tape Outdated
@mstykow mstykow force-pushed the docs/readme-scan-demo branch 3 times, most recently from 3093367 to 6bed3fe Compare July 4, 2026 22:52
@mstykow mstykow changed the base branch from main to feat/verbose-timing-breakdown July 4, 2026 22:52
Comment thread docs/demo.tape Outdated
@mstykow mstykow force-pushed the docs/readme-scan-demo branch from 6bed3fe to 6a24078 Compare July 4, 2026 23:13
@mstykow mstykow changed the title docs: add animated scan demo to README docs: add Provenant-vs-ScanCode race demo to README Jul 4, 2026
Comment thread docs/demo.tape
@mstykow mstykow force-pushed the docs/readme-scan-demo branch from 6a24078 to 8d33ab3 Compare July 4, 2026 23:26
Comment thread docs/demo.tape
@mstykow mstykow force-pushed the feat/verbose-timing-breakdown branch from d5a6c74 to c4f3299 Compare July 4, 2026 23:29
@mstykow mstykow force-pushed the docs/readme-scan-demo branch from 8d33ab3 to ff06579 Compare July 4, 2026 23:31
Base automatically changed from feat/verbose-timing-breakdown to main July 4, 2026 23:35
@mstykow mstykow force-pushed the docs/readme-scan-demo branch from ff06579 to 089d8cc Compare July 4, 2026 23:37
Add an animated side-by-side race GIF near the top of the README:
Provenant and ScanCode scanning the same astral-sh/uv repository with
identical flags (--license --package), one process each. Provenant
finishes in ~6s (139 packages, 0 errors) while ScanCode is still in early
scan. Check in the reproducible vhs tape (tmux two-pane layout) used to
generate it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Maxim Stykow <maxim.stykow@gmail.com>
@mstykow mstykow force-pushed the docs/readme-scan-demo branch from 089d8cc to f1f04da Compare July 4, 2026 23:39
@mstykow mstykow merged commit 50330d0 into main Jul 4, 2026
32 checks passed
@mstykow mstykow deleted the docs/readme-scan-demo branch July 4, 2026 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant