Update readme async docs #557
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 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
AsyncClientfunctionality.✨ Changes Made
AsyncClientusage example alongside the existing synchronousClientexample.from pydo import Clientfrom pydo import AsyncClient💡 Impact
Users now have straightforward guidance for leveraging async operations in their projects.
AsyncClientis now prominently featured in the main documentation.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
Feedback and suggestions are welcome!