docs: summarize library overview in DocC and README - #67
Merged
Conversation
Replace the placeholder DocC overview and the one-line README description with a summary of what ReliaBLE is and provides, drawn from PRD.md: device-protocol-agnostic BLE Central core, device-centric API, reliability focus, scanning, multi-peripheral support, command protocol, logging, Swift 6 architecture, and test coverage. Notes the pre-1.0 development status. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01C2RxM9mm52hyiK5oMpmVT4
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.
Replace the placeholder DocC overview and the one-line README description
with a summary of what ReliaBLE is and provides, drawn from PRD.md:
device-protocol-agnostic BLE Central core, device-centric API, reliability
focus, scanning, multi-peripheral support, command protocol, logging, Swift 6
architecture, and test coverage. Notes the pre-1.0 development status.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01C2RxM9mm52hyiK5oMpmVT4