Skip to content

Commit b19d17b

Browse files
authored
Add project documentation
1 parent 0a47677 commit b19d17b

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,39 @@
1-
# Project Template
1+
# NetBlock
22

3-
This repository serves as a template for starting new magisk/ksu/apatch modules.
3+
A per-app internet firewall for Android using KernelSU/Magisk. Block internet access for specific apps while keeping others connected.
44

5-
## Usage
5+
## Features
6+
7+
- **Per-App Blocking** : Toggle internet access per app via WebUI
8+
- **System & User Apps** : Block both user-installed and system apps
9+
- **IPv4/IPv6 Support** : Blocks all traffic on both protocols
10+
- **Backup/Restore** : Export/import blocklists config (path: `/sdcard/Downloads`)
11+
- **Auto-Verification** : Service monitors and restores rules if cleared
612

7-
Use the **"Use this template"** button to create a new repository based on this template.
13+
## Installation
814

9-
## Important
15+
1. Flash module in KernelSU/Magisk/Apatch Manager
16+
2. Reboot device
17+
3. Launch NetBlock from WebUI
18+
4. Toggle apps to block/unblock internet access
19+
20+
## Usage
1021

11-
Please do **not** fork this repository.
12-
Forking is not the intended workflow and may cause unnecessary linkage to the original template.
22+
| Action | Description |
23+
|--------|-------------|
24+
| Toggle Switch | Block/unblock app internet |
25+
| Refresh | Reload app list |
26+
| User/System | Switch between user and system apps |
27+
| Verify | Check if iptables rules are active |
28+
| Clear All | Remove all blocks instantly |
29+
| Backup | Export/import blocklist as JSON |
1330

14-
## License
31+
## Note
32+
- **Magisk Users**: Install [KSU WebUI](https://github.com/5ec1cff/KsuWebUIStandalone/releases) and grant root permission to use WebUI interface
1533

16-
MIT
34+
## Preview
35+
<table align="center">
36+
<tr>
37+
<td><img src="https://github.com/MeowDump/NetBlock/blob/main/assets/1.png" alt="1" style="max-width: 100%; height: auto;" /></td>
38+
</tr>
39+
</table>

0 commit comments

Comments
 (0)