docs: add WebSocket ledger stream documentation and endpoint examples

[Shredder401k]

Pull Request: Documentation Updates for WebSocket Streaming and Unreleased Endpoints

Summary

This PR enhances documentation by adding comprehensive WebSocket streaming examples to the README and documenting all endpoints added after v1.0.0 in the CHANGELOG.

Changes

1. WebSocket Streaming Documentation (Issue #260)

• Enhanced README.md with a complete "WebSocket Streaming" section
• Added message format specification showing the JSON structure of ledger updates:
  • sequence — Ledger sequence number
  • closedAt — ISO 8601 timestamp
  • baseFee — Base fee in stroops
  • transactionCount — Number of successful transactions
• Included CLI example using wscat with installation instructions
• Added browser WebSocket API example with full event handlers
• Included Node.js WebSocket example for server-side consumption
• All examples demonstrate connecting to ws://localhost:3000/stream/ledgers and handling live ledger updates

2. CHANGELOG.md Update (Issue #262)

• Added [Unreleased] section following Keep a Changelog format
• Documented 21 endpoints added after v1.0.0:
  • Account endpoints: age, freeze-status, pool-positions, counterparties, transactions/search, inactivity, subentry-health, sponsorship, can-receive, offer-history
  • Fee endpoints: surge-status, trends
  • DEX endpoints: spread, imbalance, arbitrage
  • Liquidity pool endpoints: profitability, reserve-ratio
  • Claimable balance endpoints: evaluate
  • Network endpoints: ledger-timing, validators
  • Asset endpoints: distribution

Testing

• ✅ No linting errors in updated markdown files
• ✅ All WebSocket examples use consistent format and working code
• ✅ CHANGELOG follows Keep a Changelog specification
• ✅ All documented endpoints verified against codebase

Acceptance Criteria Met

• ✅ Issue Add WebSocket connection example to README #260: README includes working WebSocket usage examples in both CLI and browser JS formats
• ✅ Issue Update CHANGELOG.md to record all endpoints added after v1.0.0 #262: CHANGELOG.md accurately reflects all endpoints currently in the codebase

Related Issues

Closes #260
Closes #262

[drips-wave]

@Shredder401k Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits