Repository navigation
docs: redesign the README - #16
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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/: