Skip to content

docs: add usage examples to README#200

Merged
bdraco merged 1 commit into
mainfrom
add-readme-usage-docs
Mar 8, 2026
Merged

docs: add usage examples to README#200
bdraco merged 1 commit into
mainfrom
add-readme-usage-docs

Conversation

@bdraco

@bdraco bdraco commented Mar 8, 2026

Copy link
Copy Markdown
Member

Summary

  • Add usage examples covering the main public API: GAP advertisement parsing, address utilities, distance estimation, monotonic time, and private address resolution
  • Helps new users quickly understand how to use the library

Test plan

  • Verify README renders correctly on GitHub

@bdraco bdraco marked this pull request as ready for review March 8, 2026 09:00
@bdraco bdraco merged commit 1ab67d8 into main Mar 8, 2026
40 of 42 checks passed
@bdraco bdraco deleted the add-readme-usage-docs branch March 8, 2026 09:01
@codecov

codecov Bot commented Mar 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7bf5546) to head (d30e5a3).
⚠️ Report is 98 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #200   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          255       255           
  Branches        38        38           
=========================================
  Hits           255       255           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codspeed-hq

codspeed-hq Bot commented Mar 8, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 9 untouched benchmarks


Comparing add-readme-usage-docs (d30e5a3) with main (7bf5546)

Open in CodSpeed

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