added README.md
This commit is contained in:
parent
6bb7db1fa4
commit
294055afd5
39
README.md
Normal file
39
README.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
# 🖥️ iKeyMon — macOS App for Monitoring KeyHelp Servers
|
||||||
|
|
||||||
|
iKeyMon is a native macOS app written in SwiftUI that provides live monitoring for your KeyHelp servers using the KeyHelp API.
|
||||||
|
|
||||||
|
## ✅ Current Features
|
||||||
|
|
||||||
|
- Displays key system information from your KeyHelp server via the API
|
||||||
|
- Shows CPU load, memory usage, swap usage, and disk usage
|
||||||
|
- Periodic ping via `/api/ping` endpoint to check if a server is reachable
|
||||||
|
- Colored status indicator for each server in the list
|
||||||
|
- Automatic updates:
|
||||||
|
- Ping every 10 seconds
|
||||||
|
- Server info every 60 seconds
|
||||||
|
- Organized layout using tabs: General / Resources / Services
|
||||||
|
- Stores API keys securely in the macOS Keychain
|
||||||
|
- Native macOS look & feel using SwiftUI
|
||||||
|
|
||||||
|
## 📸 Screenshots
|
||||||
|
|
||||||
|
| General | Resources | Services | Edit Server |
|
||||||
|
|--------|-----------|----------|--------------|
|
||||||
|
|  |  |  |  |
|
||||||
|
|
||||||
|
## 🛠️ Planned Features
|
||||||
|
|
||||||
|
- Preferences dialog
|
||||||
|
- macOS notifications if servers or services become unavailable
|
||||||
|
- Optional iOS support if there is demand
|
||||||
|
|
||||||
|
## 🚀 How to Run
|
||||||
|
|
||||||
|
Clone the repo and open it in [Xcode](https://developer.apple.com/xcode/). You can build and run the app on macOS 14+.
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://git.24unix.net/tracer/iKeyMon
|
||||||
|
cd iKeyMon
|
||||||
|
open iKeyMon.xcodeproj
|
||||||
|
```
|
||||||
|
|
Loading…
x
Reference in New Issue
Block a user