docs: update README for v2.4.0

[Manabu-GT]

Summary by CodeRabbit

• Documentation
  • Updated installation instructions for DebugOverlay version 2.4.0
  • Added comprehensive guide for the shake-to-open feature, including dependency setup and configuration options
  • Documented auto-install behavior and background operation details
  • Consolidated and removed duplicate documentation sections

[coderabbitai]

Warning

Rate limit exceeded

@Manabu-GT has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 52 minutes and 55 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 830773a4-b46d-4e3e-9164-1237eaf96d40

📥 Commits

Reviewing files that changed from the base of the PR and between aa83d8f and 6f0935d.

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

README.md documentation updated to reflect DebugOverlay version 2.4.0 across all installation examples. A new "Shake to open" section documents the debugoverlay-extension-trigger-shake dependency with foreground-only listening behavior and manifest-based disable instructions. Version Catalog entries and duplicate older shake documentation consolidated.

Changes

DebugOverlay 2.4.0 Release Documentation

Layer / File(s)	Summary
Shake Extension Feature README.md	New "Shake to open" section added documenting debugoverlay-extension-trigger-shake:2.4.0 dependency, foreground listening behavior, and manifest-merger instructions to disable auto-install. Duplicate older 2.3.0 shake section removed.
Version Catalog README.md	versions and libraries blocks updated to 2.4.0 for debugoverlay and new debugoverlay-trigger-shake entries. Usage example adds optional libs.debugoverlay.trigger.shake dependency alongside base and extension dependencies.
Version Bumps README.md	Core library and extension dependencies consistently updated from 2.3.0 to 2.4.0 across Quick Start, Kotlin DSL, OkHttp tracking, Timber capture, and Release builds examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Manabu-GT/DebugOverlay-Android#239: Adds the debugoverlay-extension-trigger-shake module that this PR documents with version 2.4.0 references.
• Manabu-GT/DebugOverlay-Android#187: Previously edited the manifest-based auto-install disable pattern that this PR documents and retains.
• Manabu-GT/DebugOverlay-Android#227: Related version documentation update that bumped DebugOverlay references in README to an earlier release.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change—updating README documentation for version 2.4.0 release.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-v2.4.0

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[claude]

Claude finished @Manabu-GT's task in 1m 41s —— View job

---

PR Review: README v2.4.0 update

• Read README.md changes
• Verify version numbers and module references
• Check links and code samples
• Post review feedback

Summary

Documentation-only change updating README for the v2.4.0 release. All version bumps 2.3.0 → 2.4.0 are consistent, the new debugoverlay-extension-trigger-shake artifact references match the actual module/coordinates (settings.gradle.kts, gradle.properties), the ShakeTriggerInitializer FQN matches the source (debugoverlay-extension-trigger-shake/src/main/kotlin/com/ms/square/debugoverlay/extension/trigger/shake/ShakeTriggerInitializer.kt:23), and the CHANGELOG.md entry for 2.4.0 lines up with what is being advertised. The cross-reference flip from "Timber extension above" → "Timber extension below" correctly reflects the section reordering.

No bugs, security, or correctness issues. Just a few discoverability/wording suggestions below.

Suggestions

1. Discoverability: shake feature demoted to h4 under "Headless mode" (README.md:149)

Previously this was a top-level ### Shake to open the debug panel. It is now #### Shake to open nested inside "### Headless mode (no on-screen overlay)". The shake extension works in any OverlayMode, not just Hidden, but a user running FullMetrics who scans the section list will reasonably skip the entire "Headless mode" block and miss it. The clarifying note at line 147 ("openPanel(context) works in any mode") helps a sequential reader, but does not help someone using the section index.

Two options:

• (Preferred) Promote it back to a top-level ### Shake to open between "Headless mode" and "Custom tabs". Same content, just unnested.
• Or rename "### Headless mode (no on-screen overlay)" to something like "### Programmatic panel access" so the umbrella term clearly covers both OverlayMode.Hidden and the shake trigger.

2. Wording: "as well" reads awkwardly (README.md:162)

Heads-up: shake gestures might be claimed by other dev tools as well. Only add this dependency if you don't have a competing handler.

Suggested rephrase:

Heads-up: other dev tools (e.g., Stetho, custom debug menus) may also listen for shake gestures. Only add this dependency if you don't already have a competing handler.

Naming a couple of common offenders makes the warning more actionable.

3. Minor redundancy (README.md:151 and :160)

"For a zero-config shake trigger, add the shake extension"

"Auto-installs via AndroidX Startup — shake the device to open the debug panel. No code required."

"Zero-config" and "No code required" are saying the same thing back-to-back. Dropping "No code required." would tighten this up without losing meaning.

4. Forward cross-reference to Timber XML pattern (README.md:164)

"...using the same pattern shown for the Timber extension below..."

This works, but a reader hitting the shake section first has to scroll past Custom tabs / Network / most of Timber to find the manifest snippet at lines 226–238. Acceptable as-is (avoids duplication), but if you want to make it frictionless, you could turn "below" into an anchor link to the Timber section, e.g. [the same pattern shown for the Timber extension below](#timber-log-capture).

Verification performed

• Diff vs origin/main: only README.md changed (+27/-21).
• Versions: every 2.3.0 → 2.4.0 swap accounted for (10 occurrences).
• Module name debugoverlay-extension-trigger-shake matches settings.gradle.kts and debugoverlay-extension-trigger-shake/gradle.properties.
• ShakeTriggerInitializer FQN matches the manifest entry and class declaration.
• CHANGELOG.md 2.4.0 entry advertises shake-to-open + singleTop panel — README accurately reflects the shake feature.

Nothing blocking. LGTM with the suggestions above as polish.
• Branch: docs/readme-v2.4.0

[github-actions]

Qodana for JVM

It seems all right 👌

No new problems were found according to the checks applied

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

• Or via our issue tracker: https://jb.gg/qodana-issue
• Or share your feedback: https://jb.gg/qodana-discussions