Skip to content

docs: redesign the README - #16

Merged
mpge merged 1 commit into
masterfrom
docs/readme-redesign
Nov 13, 2026
Merged

mpge merged 1 commit into
masterfrom
docs/readme-redesign

Conversation

@mpge

@mpge mpge commented Nov 13, 2026

Copy link
Copy Markdown
Member

Rewrites the README in the shared product-first layout (header, link row, two feature rows, full features grid, Built with row, quick start, Learn more).

Removed sections moved verbatim into docs/:

  • docs/installation.md: Installation, Usage
  • docs/architecture.md: Architecture, Broadcasting Event Forwarding (SDK link now points at the SDK's docs/core-api.md#broadcastable-events)
  • docs/protocol.md: Protocol
  • Related Packages and License are folded into Learn more and the licence line.

Rewrite the README in the shared short, product-first layout: centred header, link row, feature rows, a features grid, a Built with row, quick start and a Learn more list.

Removed README sections moved verbatim into docs/:
- docs/installation.md: Installation, Usage
- docs/architecture.md: Architecture, Broadcasting Event Forwarding (SDK link now points at the SDK's docs/core-api.md#broadcastable-events)
- docs/protocol.md: Protocol
- Related Packages and License are folded into Learn more and the licence line.
@mpge
mpge merged commit bd93049 into master Nov 13, 2026
3 checks passed
@mpge
mpge deleted the docs/readme-redesign branch November 13, 2026 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant