docs: clarify isRooted result field in README

[TorichanCapgo]

Summary

• add an explicit isRooted() usage example in README
• clarify that DetectionResult uses the result boolean field

Fixes confusion reported in #2.

Summary by CodeRabbit

• Documentation
  • Added a code example demonstrating async usage of isRooted(), showing how to call it and check the boolean result.
  • Clarified that DetectionResult exposes a boolean result field and made minor formatting improvements to the documentation.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

---

📝 Walkthrough

Walkthrough

Documentation update to README.md adding an example for isRooted() usage and a clarification that DetectionResult's result field is a boolean. No API, public declarations, or functional code were changed.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added an async usage example for IsRoot.isRooted() showing access of rootResult.result; clarified that DetectionResult.result is a boolean; minor formatting tweaks only.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A gentle hop through README's page,
Where code examples now engage,
isRooted() calls shine bright and clear,
No mysteries for readers here,
The result field now understood—
Our documentation's looking good! 📚✨

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately reflects the main change: adding documentation to clarify the isRooted result field in the README.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

Verify each finding against the current code and only fix it if needed.


In `@README.md`:
- Line 99: The README imports the IsRoot symbol from the wrong module name;
update the import statement that references IsRoot so it matches the installed
package scope by changing the module path from "capacitor-is-root" to
"@capgo/capacitor-is-root" wherever the import for IsRoot is used (e.g., the
line that currently reads import { IsRoot } from 'capacitor-is-root';).

[TorichanCapgo]

Fixed ✅ Updated the README example import to use in commit 0ba3e9c.

[TorichanCapgo]

Fixed ✅ Updated the README example import to use "@capgo/capacitor-is-root" in commit 0ba3e9c.