chore: update README to point to AsyncAPI guide

[swaldmann]

See also capire/docs#2819

Update README to Point to AsyncAPI Guide and General Cleanup

Documentation

📝 Simplified and updated the README.md to remove inline usage examples and direct users to the official AsyncAPI guide for documentation. Also includes minor formatting and copyright year corrections.

Changes

• README.md:
  • Fixed a trailing whitespace in the # AsyncAPI heading.
  • Updated the installation command from $ npm install @cap-js/asyncapi to npm add -D @cap-js/asyncapi.
  • Removed the inline ### Usage section containing code snippets and replaced it with a link to the AsyncAPI guide.
  • Updated the copyright year from 2024 to 2026.

• 🔄 Regenerate and Update Summary

PR Bot Information

Version: 1.29.26

• LLM: anthropic--claude-4.6-sonnet
• Correlation ID: 1f5b2920-974d-11f1-9bbf-11a5cd37ccd9
• File Content Strategy: Full file content
• Output Template: Default Template
• Summary Prompt: Default Prompt
• Event Trigger: pull_request.opened

[hyperspace-pr-bot]

Summary

The following content is AI-generated and provides a summary of the pull request:

---

Update README: Point to AsyncAPI Guide and General Cleanup

Documentation

📝 Simplified the README.md by removing inline usage examples and directing users to the official AsyncAPI guide. Includes minor formatting and copyright year corrections.

Changes

• README.md:
  • Fixed trailing whitespace in the # AsyncAPI heading.
  • Updated the installation command from $ npm install @cap-js/asyncapi to npm add -D @cap-js/asyncapi.
  • Removed the inline ### Usage section with code snippets and replaced it with a link to the AsyncAPI guide.
  • Updated the copyright year from 2024 to 2026.

---

• 🔄 Regenerate and Update Summary
• ✏️ Insert as PR Description (deletes this comment)
• 🗑️ Delete comment

PR Bot Information

Version: 1.29.26

• Output Template: Default Template
• File Content Strategy: Full file content
• Summary Prompt: Default Prompt
• Correlation ID: dd6edf40-97bd-11f1-98e3-691b63f128b2
• Event Trigger: pull_request.ready_for_review
• LLM: anthropic--claude-4.6-sonnet

[hyperspace-pr-bot]

The diff is straightforward. Let me check the Table of Contents — the ### Usage section was removed but the ToC doesn't reference it, so that's fine. The npm add -D flag installs the package as a dev dependency, which is consistent with it appearing in devDependencies in package.json. The copyright year change from 2024 to 2026 is the current year and is valid. No substantive issues found.

The PR is a clean, minimal documentation update that removes stale inline code examples in favour of the official guide, modernises the install command, and corrects the copyright year — no logic, bugs, or correctness issues are present.

PR Bot Information

Version: 1.29.26

• Event Trigger: pull_request.ready_for_review
• File Content Strategy: Full file content
• LLM: anthropic--claude-4.6-sonnet
• Correlation ID: dd6edf40-97bd-11f1-98e3-691b63f128b2