Skip to content

Replace README benchmark table with figure#19

Merged
alvinwan merged 3 commits intomainfrom
dev/alvin/readme-benchmark-figure
Apr 7, 2026
Merged

Replace README benchmark table with figure#19
alvinwan merged 3 commits intomainfrom
dev/alvin/readme-benchmark-figure

Conversation

@alvinwan
Copy link
Copy Markdown
Owner

@alvinwan alvinwan commented Apr 7, 2026

Summary

Replace the small compression table in the root README with the checked-in benchmark summary figure.

What Changed

  • remove the three-row compression table from README.md
  • embed benchmarks/summary.svg in the root README instead
  • tighten the benchmark figure layout by removing the standalone title/subtitle and shrinking the outer margins
  • regenerate benchmarks/summary.svg from benchmarks/plot.py
  • keep the surrounding benchmark validation and full-benchmarks link intact

Why

The benchmark figure now summarizes both minify-only and minify-plus-wheel compression more effectively than the old table snippet, and the tighter layout fits better as an inline README graphic.

Impact

  • the top-level README presents the benchmark summary visually instead of as a partial table
  • the embedded figure wastes less vertical space in the README
  • readers can still jump to benchmarks/README.md for the full detailed tables and validation notes
  • no runtime package behavior changes

Validation

  • ran python3 benchmarks/plot.py
  • ran xmllint --noout benchmarks/summary.svg
  • ran git diff --check

@alvinwan alvinwan marked this pull request as ready for review April 7, 2026 10:09
@alvinwan alvinwan merged commit 01989f1 into main Apr 7, 2026
10 checks passed
@alvinwan alvinwan deleted the dev/alvin/readme-benchmark-figure branch April 7, 2026 10:09
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