Skip to content

Adjust readme#97

Merged
Jose-Sabater merged 2 commits intomainfrom
improve-readme
Jun 30, 2025
Merged

Adjust readme#97
Jose-Sabater merged 2 commits intomainfrom
improve-readme

Conversation

@Jose-Sabater
Copy link
Member

No description provided.

Copy link

@agentobot agentobot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 README Overhaul ‑ Review Summary

Great work tightening up the SDK README! The new structure, badges and modernised examples substantially improve developer onboarding.

✅ What Looks Good

Area Observation
Organisation Clear intro, badges, and logical TOC
Installation Accurate pip, Poetry and UV commands
Usage Examples Sync & async patterns shown with practical Pydantic model
Streaming Docs Concise SSE explanation with context manager

💡 Minor Suggestions (non-blocking)

  1. Add from pydantic import BaseModel before declaring class RoomDescription for zero-friction copy-paste.
  2. Consider showing export OPPER_API_KEY=... rather than embedding the key in code for best practice.

No blocking issues detected. Approving.

— agentobot[bot]

@Jose-Sabater Jose-Sabater merged commit 5623635 into main Jun 30, 2025
1 check passed
@Jose-Sabater Jose-Sabater deleted the improve-readme branch June 30, 2025 10:09
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