Skip to content

docs: redesign the README - #3

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

mpge merged 1 commit into
mainfrom
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/features.md: Features
  • docs/installation.md: Requirements, Quick Start, Configuration, Peer Dependencies
  • docs/screens-and-components.md: Available Screens, Available Components, Navigation Helpers
  • docs/auth-hooks.md: Auth Hooks
  • docs/theming.md: Theme
  • docs/internationalization.md: Internationalization
  • Also Available For and License are replaced by the new README's backends sentence and 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/features.md: Features
- docs/installation.md: Requirements, Quick Start, Configuration, Peer Dependencies
- docs/screens-and-components.md: Available Screens, Available Components, Navigation Helpers
- docs/auth-hooks.md: Auth Hooks
- docs/theming.md: Theme
- docs/internationalization.md: Internationalization
- Also Available For and License are replaced by the new README's backends sentence and licence line.
@mpge
mpge merged commit 87ad935 into main Nov 13, 2026
1 check 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