Skip to content

Commit 34c2f53

Browse files
committed
Enhance README with detailed features, updated screenshots, and project notes; clarify app functionality and requirements.
1 parent b90527b commit 34c2f53

5 files changed

Lines changed: 33 additions & 6 deletions

File tree

README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,47 @@
11
# Speed
22

3-
Speed is a lightweight macOS menu bar app for quick network checks without leaving the menu bar.
3+
Speed is a lightweight macOS menu bar app for running quick network checks without leaving the menu bar.
4+
5+
It uses Apple's native `networkQuality` tool and keeps the results easy to scan, easy to compare, and close at hand.
46

57
## Preview
68

9+
### Menu bar popover
10+
711
![Speed menu bar popover](docs/images/menu-popover.png)
812

9-
![Speed settings window](docs/images/settings-window.png)
13+
### Settings overview
14+
15+
![Speed settings overview](docs/images/settings-window-overview.png)
16+
17+
### History and charts
18+
19+
![Speed history and charts](docs/images/settings-window-history.png)
1020

11-
## What It Does
21+
## Features
1222

1323
- Runs native macOS speed tests with `networkQuality`
14-
- Shows download, upload, latency, and responsiveness in a compact popover
15-
- Includes settings for launch at login and automatic test intervals
24+
- Shows download, upload, ping, and responsiveness in a compact popover
25+
- Stores measurement history locally and shows charts for 24 hours, 7 days, and 30 days
26+
- Lists recent measurements for quick comparisons
27+
- Supports automatic tests on a fixed interval
28+
- Can automatically run a fresh test after a detected network change
29+
- Lets you choose what the menu bar shows: icon only, download, ping, or download + upload
30+
- Supports launch at login
31+
- Includes built-in update checks and in-app update installation from GitHub releases
32+
- Supports English and German
33+
34+
## Requirements
35+
36+
- macOS 14 or newer
1637

1738
## Download
1839

1940
Download the latest build from [Releases](../../releases).
2041

2142
1. Download the newest `SpeedMenuBar-...-macOS.zip`
2243
2. Move `SpeedMenuBar.app` to `/Applications`
23-
3. Open the app from Applications and run tests from the menu bar
44+
3. Open the app from Applications and start tests from the menu bar
2445

2546
Note: release builds are currently ad-hoc signed and not notarized, so macOS may ask you to confirm the first launch.
2647

@@ -32,6 +53,12 @@ swift test
3253
open dist/SpeedMenuBar.app
3354
```
3455

56+
## Project Notes
57+
58+
- Speed runs as a menu bar app and does not appear in the Dock
59+
- Measurement history is stored locally on the Mac
60+
- Automatic retests on network change are enabled from Settings
61+
3562
## Contributing
3663

3764
See [CONTRIBUTING.md](CONTRIBUTING.md).

docs/images/menu-popover.png

-627 KB
Loading
849 KB
Loading
904 KB
Loading

docs/images/settings-window.png

-935 KB
Binary file not shown.

0 commit comments

Comments
 (0)