From 7922910bd8e77c234753c4cca27f4256a693d48f Mon Sep 17 00:00:00 2001 From: jknapp Date: Wed, 7 Jan 2026 14:06:52 -0800 Subject: [PATCH] Update README and version for v1.0.0 release MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add relay server documentation and setup instructions - Add relay_client.py to project structure - Add aiohttp to core dependencies - Update version.txt to 1.0.0 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 --- README.md | 21 +++++++++++++++++++++ version.txt | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7890183..ba72211 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ A cross-platform macro management application with desktop and web interfaces. C - **System Tray**: Minimize to tray, always accessible ### Additional Features +- **Relay Server Support**: Access your macros securely over HTTPS from anywhere - **QR Code Generation**: Quickly connect mobile devices - **Real-time Sync**: WebSocket updates across all connected devices - **Offline Support**: PWA caches for offline macro viewing @@ -39,6 +40,7 @@ A cross-platform macro management application with desktop and web interfaces. C - pystray (System tray) - netifaces (Network detection) - qrcode (QR code generation) +- aiohttp (Relay server client) ## Installation @@ -136,6 +138,24 @@ The web interface provides full macro management: - **Show**: Restore window - **Quit**: Exit application +### Relay Server (Remote Access) + +Access your macros from outside your local network using a relay server: + +1. Click **Settings** (gear icon) in the toolbar +2. Check **Enable Relay Server** +3. Enter your relay server URL and password +4. Click **Save** + +Once connected, a relay URL will appear in the toolbar. Use this URL from any device with internet access. The relay provides: +- Secure HTTPS connection +- Full macro execution and management +- PWA installation support +- Wake lock and fullscreen mode + +> [!NOTE] +> You need access to a relay server. See [MP-Relay](https://repo.anhonesthost.net/MacroPad/MP-Relay) for self-hosting instructions. + ## Command Types Reference | Type | Description | Parameters | @@ -213,6 +233,7 @@ MP-Server/ ├── config.py # Configuration constants ├── macro_manager.py # Macro storage and execution ├── web_server.py # FastAPI web server +├── relay_client.py # Relay server WebSocket client ├── pyproject.toml # Dependencies and build config ├── gui/ # PySide6 desktop interface │ ├── main_window.py diff --git a/version.txt b/version.txt index ac39a10..3eefcb9 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -0.9.0 +1.0.0