Skip to content

Commit a86958a

Browse files
committed
docs: update README with install instructions and clean up old snapshots
1 parent 9cbadd5 commit a86958a

4 files changed

Lines changed: 42 additions & 27 deletions

File tree

README.md

Lines changed: 42 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,59 +6,74 @@ A macOS menu bar tool for monitoring real-time network traffic per process, writ
66

77
### Status Bar
88

9-
```
9+
```text
1010
┌──────────────────────────────────────┐
11-
☀️ 🔋 ┊ 12.5KB/s ▲ ┊ Wi-Fi 🔍 │
12-
┊ 3.2KB/s ▼ ┊ │
11+
┊ 12.5KB/s ▲ ┊ Wi-Fi 🔍
12+
│ ┊ 3.2KB/s ▼ ┊
1313
└──────────────────────────────────────┘
1414
```
1515

1616
### Dropdown Menu
1717

18-
```
18+
```text
1919
┌────────────────────────────────┐
2020
│ Network Traffic │
21-
│ ↑ 12.5KB/s ↓ 3.2KB/s │
21+
│ ↑ 12.5KB/s ↓ 3.2KB/s
2222
├────────────────────────────────┤
23-
│ Chrome ↑ 8.1KB/s │
24-
│ ↓ 2.0KB/s │
25-
│ Slack ↑ 3.2KB/s │
26-
│ ↓ 1.0KB/s │
27-
│ Terminal ↑ 1.2KB/s │
28-
│ ↓ 0.2KB/s │
23+
│ Chrome ↑ 8.1KB/s
24+
│ ↓ 2.0KB/s
25+
│ Slack ↑ 3.2KB/s
26+
│ ↓ 1.0KB/s
27+
│ Terminal ↑ 1.2KB/s
28+
│ ↓ 0.2KB/s
2929
├────────────────────────────────┤
30-
│ ⚙ Settings ⌘,
31-
│ ⏻ Quit ⌘Q
30+
│ ⚙ Settings ⌘ ,
31+
│ ⏻ Quit ⌘ Q
3232
└────────────────────────────────┘
3333
```
3434

3535
### Settings Window
3636

37-
```
37+
```text
3838
┌─ Settings ─────────────────────┐
3939
│ │
4040
│ 🕐 Refresh Interval │
41-
│ ┌────────────────────────┐ │
42-
│ │ 1s 2s 3s 5s 10s
43-
│ └────────────────────────┘ │
41+
│ ┌────────────────────────┐
42+
│ │ 1s 2s 3s 5s 10s
43+
│ └────────────────────────┘
4444
│ │
4545
│ 🏎 Min Traffic Threshold │
46-
│ ┌────────────────────────┐ │
47-
│ │ All 1KB 10KB 100KB │ │
48-
│ └────────────────────────┘ │
46+
│ ┌────────────────────────┐
47+
│ │ All 1KB 10KB 100KB │
48+
│ └────────────────────────┘
4949
│ │
5050
│ 🚫 Process Blacklist │
51-
│ ┌────────────────────────┐ │
52-
│ │ Select process [▾] │ │
53-
│ └────────────────────────┘ │
54-
│ ┌─────────────────────┐ │
55-
│ │ ClashX (x) │ │
56-
│ │ Surge (x) │ │
57-
│ └─────────────────────┘ │
51+
│ ┌────────────────────────┐
52+
│ │ Select process [▾] │
53+
│ └────────────────────────┘
54+
│ ┌─────────────────────┐
55+
│ │ ClashX (x) │
56+
│ │ Surge (x) │
57+
│ └─────────────────────┘
5858
│ │
5959
└────────────────────────────────┘
6060
```
6161

62+
## Install
63+
64+
### Homebrew
65+
66+
```bash
67+
brew tap cnfatal/tap
68+
brew install --cask network-status-bar
69+
```
70+
71+
### Manual
72+
73+
Download the latest `NetworkStatusBar.zip` from [Releases](https://github.com/cnfatal/NetworkStatusBar/releases), unzip and drag `NetworkStatusBar.app` to `/Applications`.
74+
75+
> **Note:** The app is not notarized. On first launch, right-click → Open, or run `xattr -cr /Applications/NetworkStatusBar.app`.
76+
6277
## Features
6378

6479
- [x] SwiftUI based macOS menu bar app

docs/all-snapshot.png

-97.3 KB
Binary file not shown.

docs/details-snapshot.png

-45.9 KB
Binary file not shown.

docs/statusbar-snapshot.png

-4.36 KB
Binary file not shown.

0 commit comments

Comments
 (0)