diff --git a/README.md b/README.md index 3dcf025..2c7f90e 100644 --- a/README.md +++ b/README.md @@ -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:** Promise<DetectionResult> **Since:** 1.0.0