docs: rewrite README with badges, ToC, and user-friendly structure - #74
Merged
Conversation
- Add CI badges (Build, Tests, Docker Image CI), release version, and MIT licence - Add table of contents with anchor links - Reorganise into clear sections: Overview, Installation, Quick Start, Docker, Firmware Flashing, OTA Updates, Compatibility, Security, Credits - Add options table for hmland flags - Add GitHub warning callout for the pre-0.101 AES security note - Replace wall-of-text install steps with labelled code blocks https://claude.ai/code/session_012GUFo63miXVwTirEo4ApxZ
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
2 participants
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.
Summary
hmlandoptions table[!WARNING]callout for the pre-0.101 AES security notehttps://claude.ai/code/session_012GUFo63miXVwTirEo4ApxZ