Skip to content

Commit cf00dc0

Browse files
committed
Update Readme
1 parent 993eaf9 commit cf00dc0

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ In certain kernel, TCP Congestion Algorithm BBR might be enabled. Or you want to
1010
3. Reboot device.
1111

1212
## Note:
13-
1. Default algorithm is **cubic** for **cellular**.
14-
2. Default algorithm is **brr** if exists for **WiFi**. Else **cubic**.
15-
3. You can change algorithm by just renaming the file in same format. Eg: If you want to change WiFi TCP congestion algorithm to **reno**, rename `wlan_{algo}` file to `wlan_reno`.
16-
4. There is an option to kill current tcp connections during algorithm change. This might stop downloads, uploads or other ongoing connections. So apps affected might need to be restarted. To enable create a file named `kill_connections` in module folder. This is disabled by default.
17-
5. Algorithm is applied only if present in kernel.
13+
1. `{algo}` in filename can be any TCP congestion algorithm (cubic, bbr, reno etc..).
14+
2. Default algorithm is **cubic** for **cellular**.
15+
3. Default algorithm is **bbr** if exists for **WiFi**. Else **cubic**.
16+
4. You can change algorithm by just renaming the file in same format. Eg: If you want to change WiFi TCP congestion algorithm to **reno**, rename `wlan_{algo}` file to `wlan_reno`.
17+
5. There is an option to kill current tcp connections during algorithm change. This might stop downloads, uploads or other ongoing connections. So apps affected might need to be restarted. To enable create a file named `kill_connections` in module folder. This is disabled by default.
18+
6. Algorithm is applied only if present in kernel.
19+
7. Module logs are present in `/data/adb/modules/tcp_optimiser/service.log`.

0 commit comments

Comments
 (0)