Skip to content

Commit 114f2d8

Browse files
committed
Update README
1 parent 121c6f5 commit 114f2d8

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,25 @@ Use it now!
1818

1919
## Features
2020

21-
* 100% Kotlin with coroutines and Parcelize! Easy to use and virtually no boilerplate code (no aidl)
21+
* 100% Kotlin with coroutines and `Parcelize`! Easy to use and virtually no boilerplate code (no aidl)
2222
* Persistent root session that closes itself on inactive (optional and configurable)
23-
* Works around not able to `exec` on certain devices running Android 5-7.1
24-
(See `RootServer.init#shouldRelocate` if you need this feature)
23+
* Supports running native code (API 23+)
24+
25+
## Comparison with [libsu](https://github.com/topjohnwu/libsu)
26+
27+
This project achieves morally the same thing as and ports compatibility code from libsu up to v6.0.0.
28+
With that said, there are a few differences.
29+
30+
* librootkotlinx supports only API 21+ instead of 19+ for libsu.
31+
* librootkotlinx is 100% Kotlin and much easier to use with coroutines,
32+
whereas libsu uses AIDL which involves heavy boilerplate usages.
33+
* librootkotlinx is minimal and lightweight as additional features need to be manually enabled.
34+
* librootkotlinx is more reliable since it minimizes the amount of private APIs used (see listed below).
35+
This is possible also because it does not enable all features by default.
36+
* Out of the box, librootkotlinx is more secure since it uses Unix pipe instead of AIDL for IPC.
37+
* librootkotlinx works around not able to `exec` on certain devices running API 21-25.
38+
(See `RootServer.init#shouldRelocate` if you need this feature.)
39+
* libsu has some additional features such as remote file system.
2540

2641
## Private APIs used
2742

0 commit comments

Comments
 (0)