Skip to content

Update README.md - latest version - #1179

Merged
h2zero merged 1 commit into
h2zero:masterfrom
alhirzel:patch-1
Aug 3, 2026
Merged

Update README.md - latest version#1179
h2zero merged 1 commit into
h2zero:masterfrom
alhirzel:patch-1

Conversation

@alhirzel

@alhirzel alhirzel commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Suggest the latest version (2.5.1) rather than an older version on README (for PlatformIO users).

Summary by CodeRabbit

  • Chores
    • Updated the required NimBLE-Arduino version to 2.5.1 or newer for PlatformIO projects.

Suggest the latest version (2.5.1) rather than an older version on README (for PlatformIO users).
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Arrr, the README now requires NimBLE-Arduino ^2.5.1 for PlatformIO installation. No public declarations changed.

Changes

PlatformIO Dependency Documentation

Layer / File(s) Summary
Update installation requirement
README.md
The PlatformIO installation instruction now requires NimBLE-Arduino ^2.5.1 instead of ^2.1.0, arrr!

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

A version flag sails ahead,
From ^2.1.0 to ^2.5.1 it’s led.
The README marks the chart,
With a tiny change of art.
Smooth seas for setup, matey!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title identifies the README update but does not specify the NimBLE-Arduino dependency or version 2.5.1. Specify the dependency and target version, for example: "Update README.md to require NimBLE-Arduino 2.5.1".
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 34: Update the NimBLE-Arduino dependency version in docs/index.md to
match the canonical README.md recommendation of ^2.5.1, or regenerate
docs/index.md from that source while preserving the existing installation
instructions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d0741820-6a81-49a5-8dbb-dcba91da5301

📥 Commits

Reviewing files that changed from the base of the PR and between 7b4c341 and f82a732.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
@h2zero
h2zero merged commit 2c487b7 into h2zero:master Aug 3, 2026
44 checks passed
@h2zero

h2zero commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Thanks!

@alhirzel
alhirzel deleted the patch-1 branch August 4, 2026 13:13
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.

2 participants