Skip to content

docs: restore README badges, screenshots, and PyPI-compatible links (v0.4.3) - #13

Merged
diegoalvarezmgl merged 1 commit into
mainfrom
docs/readme-badges-images
Jul 5, 2026
Merged

docs: restore README badges, screenshots, and PyPI-compatible links (v0.4.3)#13
diegoalvarezmgl merged 1 commit into
mainfrom
docs/readme-badges-images

Conversation

@diegoalvarezmgl

Copy link
Copy Markdown
Owner

Summary

Fixes the broken README shipped in v0.4.2:

  • Restores shields.io badges (PyPI, Python, CI, License)
  • Restores tearsheet screenshots for all four HTML report types using absolute raw.githubusercontent.com URLs (works on GitHub and PyPI)
  • Fixes interactive classic sample link via HTMLPreview (instead of raw HTML source)
  • Converts relative doc links to absolute GitHub URLs for PyPI rendering

Docs-only patch release: 0.4.3

Test plan

  • pytest (255 passed)
  • python -m build + twine check dist/* (PASSED)

After merge

  1. Tag: git tag -a v0.4.3 -m "v0.4.3 — README badges, screenshots, PyPI-compatible links"
  2. Push tag: git push origin v0.4.3
  3. Create GitHub release from tag → triggers python-publish.yml → PyPI publish

Made with Cursor

…v0.4.3)

- Restore shields.io badges at top of README
- Add tearsheet screenshots with absolute raw.githubusercontent.com URLs
- Fix interactive tearsheet link via HTMLPreview
- Convert relative doc links to absolute GitHub URLs for PyPI rendering

Co-authored-by: Cursor <cursoragent@cursor.com>
@diegoalvarezmgl
diegoalvarezmgl merged commit efec084 into main Jul 5, 2026
6 checks passed
@diegoalvarezmgl
diegoalvarezmgl deleted the docs/readme-badges-images branch July 5, 2026 21:53
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