Skip to content

Commit dc0ebc7

Browse files
docs: add diagnostic and performance validation steps to README
1 parent 472aef1 commit dc0ebc7

1 file changed

Lines changed: 40 additions & 8 deletions

File tree

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,22 +79,54 @@ sudo ./build/droidtether
7979

8080
## 🔍 Verifying Connectivity
8181

82-
While the daemon is running, you can verify everything is working in another terminal:
82+
Once DroidTether is installed and your phone is connected, you can run these commands to verify the bridge is active:
8383

84-
### 1. Check the Route 🛣️
84+
### 1. Check the Service Status ⚙️
85+
```bash
86+
sudo launchctl list | grep princePal
87+
# Expected: A process ID (number) should appear, e.g., "67337 0 com.princePal.droidtether"
88+
```
89+
90+
### 2. Check the Network Interface 📡
91+
```bash
92+
ifconfig | grep -A 5 utun
93+
# Expected: You should see a 'utun' interface with an 'inet' address (e.g., 10.x.x.x)
94+
```
95+
96+
### 3. Verify the Routing 🛣️
8597
```bash
8698
route -n get google.com | grep interface
87-
# Should return: interface: utunX
99+
# Expected: interface: utunX (where X is your DroidTether interface number)
88100
```
89101

90-
### 2. Test DNS 📡
102+
### 4. Monitor Live Traffic 📜
91103
```bash
92-
nslookup google.com
93-
# Should resolve via your phone's gateway (e.g., 10.215.9.141)
104+
tail -f /var/log/droidtether.log
105+
# Expected: "🚀 Traffic Monitor" logs showing received/sent data totals.
94106
```
95107

96-
### 3. Clean Exit 🛑
97-
Simply press **`Ctrl+C`** in the daemon window. DroidTether will instantly clean up your routes, reset your DNS, and close the virtual interface.
108+
### 5. Performance & Quality Test ⚡
109+
```bash
110+
ping -c 10 8.8.8.8
111+
# Expected: 0% packet loss and stable round-trip times.
112+
# Note: If latency is high, try switching your phone from 5G to 4G/LTE for better stability.
113+
```
114+
115+
---
116+
117+
## 🛑 Stopping & Uninstalling
118+
119+
### Stop the Background Service
120+
If you want to stop the service momentarily without uninstalling:
121+
```bash
122+
sudo launchctl bootout system /Library/LaunchDaemons/com.princePal.droidtether.plist
123+
```
124+
125+
### Complete Uninstall
126+
To completely remove DroidTether, its configuration, and the background service:
127+
```bash
128+
curl -sL https://raw.githubusercontent.com/HelloPrincePal/DroidTether/main/uninstall.sh | bash
129+
```
98130

99131
---
100132

0 commit comments

Comments
 (0)