Skip to content

docs: overhaul README and add banner + demo assets for public launch - #125

Merged
CodeNinjaSarthak merged 1 commit into
mainfrom
docs/readme-overhaul-and-assets
May 5, 2026
Merged

docs: overhaul README and add banner + demo assets for public launch#125
CodeNinjaSarthak merged 1 commit into
mainfrom
docs/readme-overhaul-and-assets

Conversation

@CodeNinjaSarthak

Copy link
Copy Markdown
Owner

Summary

  • Rewrites README from scratch with banner, badges, demo GIFs, full setup instructions, and architecture overview
  • Adds asset/banner.svg, asset/demo-discovery.gif, asset/demo-refine.gif
  • Raises pre-commit large-file limit to 5000 KB to accommodate demo GIFs

Test plan

  • Verify banner and GIFs render correctly on the GitHub repo page
  • Confirm all README links and badge URLs resolve
  • Confirm pre-commit hooks pass (uv run pre-commit run --all-files)

@CodeNinjaSarthak
CodeNinjaSarthak merged commit ef44cb1 into main May 5, 2026
2 checks passed
@CodeNinjaSarthak
CodeNinjaSarthak deleted the docs/readme-overhaul-and-assets branch May 5, 2026 05:07
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