Skip to content

Commit 51507e8

Browse files
committed
update: README.md with more info
This commit updates the README.md to contain more info about the existence of the project and Rust libraries used.
1 parent af96b85 commit 51507e8

1 file changed

Lines changed: 31 additions & 7 deletions

File tree

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,47 @@
11
# ReZygisk
22

3-
ReZygisk is a fork of Zygisk Next by Dr-TSNG, which is a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, Magisk and APatch.
3+
ReZygisk is a fork of Zygisk Next, which is a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, Magisk (besides built-in) and futurely APatch.
44

5-
It aims at the re-write of Zygisk Next to C, allowing also a more efficient and faster implementation of the Zygisk API with a more permissive license.
5+
It aims at the modernization and re-write of the codebase to C (from C++ and Rust), allowing a more efficient and faster implementation of the Zygisk API with a more permissive license.
66

77
> [!NOTE]
88
> This module/fork is WIP, only use .zip from the releases.
99
10+
## Why?
11+
12+
The latest releases of Zygisk NExt are not open-source, reserving entirely the code for its developers. Not only that limits our ability to contribute to the project, but also impossibilitates the audit of the code, which is a major concern for security, as Zygisk Next is a module that runs with superuser (root) privileges, having access to the entire system.
13+
14+
The Zygisk Next developers are famous and trusted in the Android community, however this doesn't mean that the code is not malicious or vulnerable. We (PerformanC) understand they have their reasons to keep the code closed-source, but we believe that contrary.
15+
1016
## Features
1117

12-
- Open Source
18+
- FOSS (forever)
19+
- Better hiding standalone
1320

1421
## Dependencies
1522

16-
- rust
23+
- rustc
24+
- Android NDK
25+
26+
### Rust side:
27+
28+
- android_logger
29+
- anyhow
30+
- bitflags
31+
- const_format
32+
- futures
33+
- konst
34+
- lazy_static
35+
- libc
36+
- log
37+
- memfd
38+
- num_enum
39+
- passfd
40+
- proc-maps
1741

18-
### Rust-side:
42+
### C++ side:
1943

20-
-
44+
- lsplt
2145

2246
## Installation
2347

@@ -37,4 +61,4 @@ It is mandatory to follow the PerformanC's [contribution guidelines](https://git
3761

3862
## License
3963

40-
ReZygisk is licensed majoritaly under GPL, by Dr-TSNG, but also BSD 2-Clause License. You can read more about it on [Open Source Initiative](https://opensource.org/licenses/BSD-2-Clause).
64+
ReZygisk is licensed majoritaly under GPL, by Dr-TSNG, but also BSD 2-Clause License for re-written code. You can read more about it on [Open Source Initiative](https://opensource.org/licenses/BSD-2-Clause).

0 commit comments

Comments
 (0)