Skip to content

Rewrite README as a library-facing overview#1

Merged
Levvvi merged 1 commit into
mainfrom
docs/readme-rewrite
Jun 14, 2026
Merged

Rewrite README as a library-facing overview#1
Levvvi merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@Levvvi

@Levvvi Levvvi commented Jun 14, 2026

Copy link
Copy Markdown
Owner

Summary

This PR rewrites the root README.md to present MOSADE as a library-facing portfolio project rather than an internal research repository.

Changes

  • Adds a clearer project overview and positioning.
  • Documents installation and basic usage.
  • Highlights engineering status: CI, tests, coverage, build verification, and package structure.
  • Clarifies the separation between the shippable library core and the experiments/ research artifacts.
  • Avoids unsupported claims about algorithm superiority.

Verification

This PR changes documentation only.

Expected CI checks:

  • Ruff lint
  • Pytest
  • Coverage gate for src/mosade
  • Wheel and sdist build
  • Python 3.10, 3.11, and 3.12 matrix

@Levvvi Levvvi merged commit 59fb149 into main Jun 14, 2026
3 checks passed
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