Add StreamEventAggregator section to README

[aleksandar-apostolov]

Goal

Document the Event Aggregator in the README, with specific guidance on handling aggregated events in subscriptions.

Implementation

• New Event Aggregator section in Feature Guides covering:
  • Adaptive behavior (individual vs batched delivery)
  • Event ordering: flat List<T> in arrival order (not Map<String, List<T>>)
  • Why ordering matters (e.g. "reaction added" before "reaction removed")
  • Code examples for onEvent handling both paths
  • Specific subsection on handling StreamAggregatedEvent in StreamClientListener
• Updated Subscription Management section with a note about aggregated events
• Updated Table of Contents

Testing

• README renders correctly on GitHub
• Code examples match current API (List-based StreamAggregatedEvent)

pr: core

[coderabbitai]

Warning

Rate limit exceeded

@aleksandar-apostolov has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 16 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e53a3842-79bf-4c81-8f01-fe73c271414e

📥 Commits

Reviewing files that changed from the base of the PR and between 5d94332 and 6dd3eb2.

📒 Files selected for processing (1)

• README.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/event-aggregator-readme-v2

---

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

_{Review rate limit: 0/1 reviews remaining, refill in 55 minutes and 16 seconds.}

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

[github-actions]

PR checklist ✅

All required conditions are satisfied:

• Title length is OK (or ignored by label).
• At least one pr: label exists.
• Sections ### Goal, ### Implementation, and ### Testing are filled.

🎉 Great job! This PR is ready for review.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[stream-public-bot]

🚀 Available in v5.0.0