Conversation
There was a problem hiding this comment.
Pull request overview
This PR comprehensively restructures the README.md to improve clarity, organization, and user experience. The documentation has been modernized with better visual hierarchy, clearer feature descriptions, and more streamlined content flow.
Key changes include:
- Updated Python version requirement from 3.8+ to 3.13+ (consistent with pyproject.toml)
- Reorganized content with improved section hierarchy and table-based feature descriptions
- Enhanced Quick Start guide with clearer options for cloud vs self-hosted deployment
- Expanded Core APIs section with detailed retrieval method comparisons
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
|
|
||
| ## 🤝 Ecosystem | ||
|
|
||
| We're proud to work with amazing organizations: | ||
| --- |
There was a problem hiding this comment.
There are duplicate horizontal rules (---) on lines 271 and 274. One of these should be removed to maintain clean formatting.
|
|
||
| **Performance Excellence in Locomo Tests:** | ||
| ```bash | ||
| pip install -e . |
There was a problem hiding this comment.
The installation instruction uses "pip install -e ." which installs the package in editable/development mode. For a "Quick Start" section aimed at end users, this should likely be "pip install memu-py" (the published package name from PyPI as shown in the badge) unless the intention is specifically for users to clone the repository and install from source in development mode. Consider clarifying the intended installation method or adding both options with clear labels (e.g., "From PyPI" vs "From Source").
| pip install -e . | |
| pip install memu-py |
No description provided.