Skip to content

docs: align README with current implementation (issue #34) #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ShadyUnderLight merged 1 commit into from
Apr 21, 2026
Merged

docs: align README with current implementation (issue #34) #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ GitHub Actions now builds the Swift package and app bundle automatically on push
## Notes on CPU temperature
macOS does not expose CPU temperature through a stable public API for normal apps. This app therefore:
- tries to read temperature from installed helper tools such as `osx-cpu-temp` or `istats`
- falls back to `--` plus thermal state if no helper is available
- on Apple Silicon: reads HID sensors first, falls back to helper tools
- shows an actionable hint (e.g. install hint on Intel, permission check on Apple Silicon) when temperature is unavailable — no silent `--`
- does **not** require sudo or private entitlements

## Known limitations
Expand All @@ -71,8 +72,7 @@ macOS does not expose CPU temperature through a stable public API for normal app
- The app is still being polished for wider public release

## Roadmap ideas
- Sparklines / history
- Per-process actions
- Per-process actions (e.g. kill, priority adjustment)
- Better sensor integrations
- Further performance tuning

Expand Down
6 changes: 3 additions & 3 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ GitHub Actions 已经配置好，会在 push、pull request 和版本 tag 时自
## 关于 CPU 温度
macOS 没有为普通应用提供稳定的公开 CPU 温度 API，所以这个项目会：
- 尝试读取已安装的辅助工具，例如 `osx-cpu-temp` 或 `istats`
- 如果没有可用辅助工具，就回退显示为 `--` 和热状态
- Apple Silicon 机型：优先读取 HID 传感器，辅助工具作为后备
- 温度不可用时显示可操作提示（Intel 提示安装工具，Apple Silicon 提示检查权限），不会静默显示 `--`
- **不需要** sudo，也不依赖私有 entitlement

## 已知限制
Expand All @@ -70,8 +71,7 @@ macOS 没有为普通应用提供稳定的公开 CPU 温度 API，所以这个
- 这个应用还在继续打磨，离更成熟的公开版本还有一些工作

## Roadmap 想法
- 趋势图 / 历史曲线
- 针对进程的操作按钮
- 针对进程的操作按钮（如结束进程、优先级调整）
- 更好的传感器集成
- 进一步的性能优化

Expand Down