Update README.md

[chilijung]

Summary by CodeRabbit

• Documentation
  • Improved the "Ask questions" example with enhanced formatting and clearer narrative structure for better usability
  • Updated the "What works today" section to more accurately reflect current engine capabilities and Agent SDK features
  • Streamlined the README by removing outdated placeholder sections to improve document flow and readability

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 16a289d4-d18e-48d3-b21b-123ac8515d7a

📥 Commits

Reviewing files that changed from the base of the PR and between 7156bcb and f84988a.

📒 Files selected for processing (1)

• README.md

---

Walkthrough

README.md receives minor documentation refreshes: the "Ask questions" example is reformatted as a narrative prompt block, feature descriptions in "What works today" are reworded and expanded with wren-pydantic details, and the placeholder "STAR HISTORY" section is removed.

Changes

README Documentation Refresh

Layer / File(s)	Summary
README example and feature descriptions README.md	The "Ask questions" example is replaced with a narrative prompt header and question text. "What works today" bullets are reworded (Engine: removed "(Canner fork)"; Agent SDK: added wren-pydantic and reworded shipping status). The "STAR HISTORY" / "Used by" placeholder section is deleted.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Canner/WrenAI#2292: Both PRs modify README.md content, primarily reworking examples and wording around "Ask questions" and "What works today" feature descriptions.
• Canner/WrenAI#2253: Both PRs modify README.md documentation sections, including rewording bullets and updating the "Ask questions" / Community-related content areas.
• Canner/WrenAI#1665: Both PRs update and reorganize README.md documentation, including changes to examples and section structure.

Suggested labels

documentation

Suggested reviewers

• cyyeh
• wwwy3y3

Poem

📖 A README grows clearer with each careful word,
Agent SDK shines brighter, its true nature heard,
Placeholder phantoms fade, the path lies clean,
From "Ask any questions" to features serene,
A hop toward clarity! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chilijung-patch-2

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}