Skip to content

README polish post-PyPI release#4

Merged
SwathiMystery merged 1 commit intomainfrom
readme-polish
Apr 23, 2026
Merged

README polish post-PyPI release#4
SwathiMystery merged 1 commit intomainfrom
readme-polish

Conversation

@SwathiMystery
Copy link
Copy Markdown
Collaborator

First pass of README improvements after v0.1.0 published to PyPI.

Changes

  • Banner: relative path `docs/assets/banner.svg` → absolute `raw.githubusercontent.com` URL. PyPI project page now renders the banner correctly (sdist doesn't include `docs/`).
  • Badges: added PyPI version + downloads + pyversions (dynamic from PyPI). Drops redundant static "Python 3.10+" badge.
  • Top nav row removed: GitHub renders TOC natively in the sidebar; PyPI ignores anchor links in the middle of a header block.
  • Alpha callout added under Install — sets expectations for first-time PyPI visitors.
  • Status badge now links to `/releases` instead of repo root so it's actually useful.

Not in scope (future PRs)

  • Asciicast / terminal recording for the "product in 15 seconds" demo.
  • MCP config JSON snippet inline (currently behind `lore install`).
  • Command-table grouping (Capture / Query / Setup).

- Banner: relative path → absolute raw.githubusercontent URL so PyPI project page renders it correctly
- Badges: PyPI version + downloads + pyversions (drops static "Python 3.10+" for dynamic pypi source)
- Drop redundant top nav row (GitHub renders TOC natively, PyPI doesn't need it)
- Alpha status callout under Install so first-time visitors set expectations
- Status badge now links to releases, not repo root
@SwathiMystery SwathiMystery merged commit 7604da8 into main Apr 23, 2026
7 checks passed
@SwathiMystery SwathiMystery deleted the readme-polish branch April 23, 2026 05:12
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