Skip to content

Rewrite the README for discovery and adoption - #2

Open
0j0bit wants to merge 1 commit into
mainfrom
docs/discoverability-readme
Open

0j0bit wants to merge 1 commit into
mainfrom
docs/discoverability-readme

Conversation

@0j0bit

@0j0bit 0j0bit commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Rewrites the README for discovery and adoption, consistent with the new mcl-core front page.

  • A searchable one-paragraph definition under the tagline, using the terms builders search for.
  • What the repository provides, how to use it, maturity (Stable / Candidate / Research Draft), hardware verification records, and related repositories.
  • Removed claim, review-status and "both ends compile the same sources" qualifier prose.
  • Banner alt text is now descriptive.
  • Every relative and cross-repository link was checked against tracked files; ../ links, which do not resolve on GitHub, are replaced with absolute URLs.

Documentation only. No protocol or specification semantics change.

🤖 Generated with Claude Code

Lead with a searchable definition of the BLE binding, what it provides, how to use it,
maturity, verification records and related repositories. Remove claim and
review-status prose, and give the banner descriptive alt text.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@0j0bit
0j0bit requested a review from sed-boi as a code owner September 13, 2026 07:18
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