fix(readme): document socket transport and clarify stdio/socket differences in README

This commit is contained in:
2026-02-26 08:50:53 +00:00
parent d762c26565
commit a29201b1c5
3 changed files with 170 additions and 17 deletions

View File

@@ -1,5 +1,16 @@
# Changelog
## 2026-02-26 - 1.3.1 - fix(readme)
document socket transport and clarify stdio/socket differences in README
- Add 'Two Transport Modes' section documenting stdio (spawn) and socket (connect) modes
- Add examples for connect(), socket usage, and auto-reconnect with exponential backoff
- Clarify protocol is transport-agnostic and update ready/stream/event descriptions
- Update event docs: mark stderr as stdio-only and add 'reconnected' event for socket transports
- Clarify kill() behavior for both stdio and socket transports
- Add API reference entries for SocketTransport, StdioTransport, ISocketConnectOptions, IRustTransport, and LineScanner
- Add platform notes, architecture diagram, and minimal Rust/socket usage guidance
## 2026-02-26 - 1.3.0 - feat(transport)
introduce transport abstraction and socket-mode support for RustBridge