From 294055afd5e300a3e97b24393c600b1bcda9aadd Mon Sep 17 00:00:00 2001
From: Micha <espey@smart-q.de>
Date: Sun, 6 Apr 2025 13:40:09 +0200
Subject: [PATCH] added README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b0057e0
--- /dev/null
+++ b/README.md
@@ -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 |
+|--------|-----------|----------|--------------|
+| ![General](Screenshots/general_view.png) | ![Resources](Screenshots/resources_view.png) | ![Services](Screenshots/services_view.png) | ![Edit](Screenshots/edit_server.png) |
+
+## 🛠️ 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
+```
+