Skip to content

Commit c37a10a

Browse files
authored
Update README.md
1 parent a4022b0 commit c37a10a

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,13 @@
1010
## 🌟 Key Features
1111

1212
- **Strict Integrity**: Uses the **Fletcher-16** algorithm—significantly more reliable than simple sum-checks for catching bit-flips and swapped bytes.
13+
1314
- **COBS Framing**: Implements *Consistent Overhead Byte Stuffing*. By using `0x00` as a unique delimiter, the protocol never "desyncs" and is immune to payload data being mistaken for control characters.
15+
1416
- **Event-Driven API**: Support for **Asynchronous Callbacks** via `onReceive()`. Handle data the moment it arrives without cluttering your `loop()`.
17+
1518
- **Zero-Copy & Zero-Heap**: Optimized for 8-bit AVR. No dynamic memory allocation; data is processed directly in static buffers.
19+
1620
- **Multi-Platform**: Native adapters for **Arduino**, **Linux (POSIX)**, **Windows (Win32)**, **ESP-IDF**, and **STM32 HAL**.
1721

1822
---
@@ -156,6 +160,7 @@ Serial.print("Timeouts: "); Serial.println(stats.timeouts);
156160
```
157161

158162
## 📂 Project Structure
163+
159164
`src/`: Core protocol logic (`TinyLink.h`, `TinyProtocol.h`).
160165
`src/adapters/`: Hardware-specific drivers (Arduino, Posix, Windows, etc.).
161166
`examples/`: Ready-to-run duplex, callback, and health-monitoring demos.

0 commit comments

Comments
 (0)