Skip to content

Improve README: header, badges, quickstart, and repo cross-links#10

Merged
mishanefedov merged 1 commit into
mainfrom
readme-refresh
Jun 13, 2026
Merged

Improve README: header, badges, quickstart, and repo cross-links#10
mishanefedov merged 1 commit into
mainfrom
readme-refresh

Conversation

@mishanefedov

@mishanefedov mishanefedov commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Restructured the README with a centered header, badges, and in-page navigation
  • Added a quickstart and a star-history chart
  • Added a short section linking the other Unison Labs repositories

Test plan

  • README renders correctly on GitHub
  • Install and usage commands unchanged

Summary by cubic

Revamps the README with a centered header, clear quickstart, and better navigation to make the SDK easier to install and use. Adds repo cross-links and a star history chart to improve discovery.

  • New Features
    • Centered header with logo, tagline, and badges (CI, PyPI, Python, MIT, stars)
    • In-page nav links for Installation, Quickstart, API Reference, Contributing
    • Quickstart moved up and simplified; clarified Python 3.9+ and pip install unisonlabs
    • Renamed “Resources” to “API Reference” and tightened copy
    • Added star history chart
    • Added “Unison Labs constellation” section linking related repos

Written for commit ce6bc73. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@mishanefedov mishanefedov merged commit 663a150 into main Jun 13, 2026
4 checks passed
@mishanefedov mishanefedov deleted the readme-refresh branch June 13, 2026 16:06
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