Description
Description
We should improve our README.md file to better reflect the purpose, usage, and installation instructions for the project. It would be great to follow the style and structure of the main strawberry project and the strawberry-django project for consistency and clarity.
README Improvements Suggestions
Here are some things I think we should update to improve clarity and align the style with the main Strawberry project:
📌 Title
- Change the title from
strawberry-sqlalchemy-mapperto something more descriptive, such as:
Strawberry GraphQL SQLAlchemy Integration
📎 Badges & Icons
- Add relevant badges to highlight the project's status and integrations:
- PyPI version
- Discord community
- Test status
- Code coverage (Codecov)
- Download count
- Supported Python versions (we support Python 3.8+)
Example:
🛠️ Prerequisites
- Fix small typo: remove the
_inpre-commitunder the Prerequisites section.
✨ Additional Enhancements
- If you notice other areas for improvement (structure, clarity, tone), feel free to propose them!
- While I don't think new code examples right now, it might be worth mentioning support for somefeatures like:
Feature Request Type
- Core functionality
- Alteration (enhancement/optimization) of existing feature(s)
- New behavior