Skip to content

docs: clarify isRooted result field in README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
riderx merged 2 commits into from
Feb 21, 2026
Merged

docs: clarify isRooted result field in README #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e96b9d
docs: clarify isRooted() returns DetectionResult.result
TorichanCapgo Feb 16, 2026
0ba3e9c
docs: fix package import scope in isRooted example
Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,19 @@ This is the recommended method for basic root/jailbreak detection.
It runs a combination of the most reliable detection heuristics for the platform.
Works on both Android and iOS.

Example:

```ts
import { IsRoot } from '@capgo/capacitor-is-root';

const rootResult = await IsRoot.isRooted();
if (rootResult.result) {
console.log('Device is rooted');
}
```

> `DetectionResult` uses the `result` field (`boolean`).

**Returns:** <code>Promise&lt;<a href="#detectionresult">DetectionResult</a>&gt;</code>

**Since:** 1.0.0
Expand Down