Skip to content

Commit 815f29c

Browse files
authored
Update README.md
1 parent dbcba8a commit 815f29c

1 file changed

Lines changed: 24 additions & 7 deletions

File tree

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,36 @@
11
# react-native-verify-device-root
22

3-
## Getting started
3+
Verify device root for [React Native](https://github.com/facebook/react-native).
44

5-
`$ npm install react-native-verify-device-root --save`
5+
## Installation
66

7-
### Mostly automatic installation
7+
Using npm:
88

9-
`$ react-native link react-native-verify-device-root`
9+
```shell
10+
npm install --save react-native-verify-device-root
11+
```
12+
13+
or using yarn:
14+
15+
```shell
16+
yarn add react-native-verify-device-root
17+
```
18+
19+
## Linking (React Native >= 0.60 skip this as auto-linking should work)
20+
21+
#### Notes
22+
23+
> Work only on Android, open for pull requests.
1024
1125
## Usage
1226
```javascript
1327
import VerifyDeviceRoot from 'react-native-verify-device-root';
1428

15-
## Work only on Android
29+
const root = await VerifyDeviceRoot.isRooted();
1630

17-
// TODO: What to do with the module?
18-
VerifyDeviceRoot;
31+
return true or false
1932
```
33+
34+
### ©️ Open source - licence
35+
36+
Repository and contributions are under [GNU General Public License v3.0](https://github.com/GleidsonDaniel/transactions-manager/blob/develop/LICENSE)

0 commit comments

Comments
 (0)