Skip to content

Restructure README for faster onboarding - #42

Merged
devcodes9 merged 2 commits into
mainfrom
docs/readme-refresh
Aug 22, 2026
Merged

Restructure README for faster onboarding#42
devcodes9 merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@devcodes9

Copy link
Copy Markdown
Owner

Summary

  • reorganize the README around quick start, features, installation, and common commands
  • shorten the native resume comparison while keeping ranking limits and local-only behavior explicit
  • remove stale query-operator and --fuzzy claims, and use absolute links that work on PyPI

Test plan

  • python3 -m unittest discover -s tests (101 tests)
  • build wheel and sdist, then run twine check
  • git diff --check

Made with Cursor

devcodes9 and others added 2 commits August 22, 2026 18:17
Make the project easier to evaluate on a cold read while removing stale search behavior claims.

Co-authored-by: Cursor <cursoragent@cursor.com>
@devcodes9
devcodes9 merged commit 84a154a into main Aug 22, 2026
6 checks passed
@devcodes9
devcodes9 deleted the docs/readme-refresh branch August 22, 2026 15:13
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