Commit Graph

10 Commits

Author SHA1 Message Date
Frost 2ad5b606c3 Update README with new demo link and test info
Updated the live demo link and clarified file transfer test details.
2026-07-08 18:11:13 +01:00
Frost ed22655f5b Revise file transfer scenarios in README
Updated file transfer scenarios and added details on performance improvements.
2026-07-08 18:11:13 +01:00
infrost db447ec0a0 update readme.md 2026-07-08 18:08:48 +01:00
Hermit 527d0e7b4e Update README.md 2026-07-08 18:08:00 +01:00
Hermes Agent 383b2f81d3 Replace em dashes with regular dashes in package.json, README, ARCHITECTURE 2026-05-04 16:34:13 +00:00
Hermes Agent 80c0a23bbd Fix --serve: strip Vite base path, add --port/--host flags 2026-05-04 16:05:26 +00:00
Hermes Agent 2500796edd docs: split README into README.md and ARCHITECTURE.md
README.md now focuses on user-facing content:
- General description and live demo link
- Installation instructions (npm, Bun, npx, bunx)
- CLI usage examples (file, stdin, --serve)
- CLI flags table
- Dev setup with all relevant commands and scripts
- Link to ARCHITECTURE.md

ARCHITECTURE.md contains all technical implementation details:
- High-level architecture diagram
- Full project structure tree
- Runtime and dev dependencies
- Protocol spec (packet format, constants, metadata wrapping)
- Algorithm deep dives (RLNC, GF256, QR encode/decode, GIF, scheduling)
- Sender and receiver data flow diagrams
- Design decisions and rationale
- Common pitfalls
2026-05-04 01:56:16 +00:00
Hermes Agent 87bd318adc v0.4: outer RS error correction, scanner timer, generation-based progress
- Add outer Reed-Solomon error correction across generations
  (3% overhead, 1 parity gen per ~33 source gens)
- Fix progress display: show generations solved/needed instead of
  raw packet counts, making outer EC benefit visible
- Add decode timer: tracks elapsed time from first frame to completion
  and shows throughput in KB/s
- Add benchmark test confirming outer EC reduces tail waiting time
  under biased frame loss
- Remove per-generation hash verification (superseded by outer RS)
- Update deployment base path to /hermes-web-demos/qr/
2026-05-03 19:04:06 +00:00
Hermes Agent 036375a5eb docs: comprehensive README for onboarding 2026-05-03 14:50:28 +00:00
Hermes Agent b20e5c9c17 Initial implementation: QR-over-GIF Transfer System
- Protocol: packet format, CRC32C, CBOR manifest, fragmentation
- FEC: GF(256) arithmetic, xoshiro128** PRNG, systematic RLNC encoder/decoder
- QR: generation (qrcode-generator), rasterization (3px/module), decoding (jsQR)
- GIF: animated GIF generation (gifenc) with 2-colour palette
- Preprocessing: deflate compression, SHA-256 hashing
- Sender pipeline: packetizer, frame scheduler with interleaving
- Workers: encode, gif generation, decode/reconstruction in Web Workers
- UI: Preact SPA with Sender/Receiver tabs, dark theme
- Tests: 93 passing (unit, property-based, integration, E2E)
- Default profile: Robust (V31-Q, K=24, R=12)
- Deployed to /hermes-web-demos/qr-transfer/
2026-05-02 21:37:06 +00:00