Skip to content

Conversation

LifeJiggy
Copy link

📝 Update README: AsyncClient Documentation & Usage Examples

This PR enhances the project’s README by adding comprehensive documentation and clear usage examples for the newly exposed AsyncClient functionality.


✨ Changes Made

  • Installation Instructions:
    • Added guidance for installing with async support:
      pip install pydo[aio]
  • Quickstart Section:
    • Introduced a new AsyncClient usage example alongside the existing synchronous Client example.
    • Clarified import statements for both:
      • Synchronous: from pydo import Client
      • Asynchronous: from pydo import AsyncClient

💡 Impact

  • Better Documentation:
    Users now have straightforward guidance for leveraging async operations in their projects.
  • Improved Discoverability:
    AsyncClient is now prominently featured in the main documentation.
  • Complete Examples:
    Both synchronous and asynchronous usage patterns are clearly demonstrated, making it easier for users to adopt either approach.

🗂️ Files Changed

  • README.md — Expanded installation and usage documentation.

🔄 Backward Compatibility

  • All existing documentation remains unchanged.
  • No breaking changes to existing functionality or interface.

Feedback and suggestions are welcome!

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