Update README and version for v1.0.0 release
- 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 <noreply@anthropic.com>
This commit is contained in:
21
README.md
21
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
|
- **System Tray**: Minimize to tray, always accessible
|
||||||
|
|
||||||
### Additional Features
|
### Additional Features
|
||||||
|
- **Relay Server Support**: Access your macros securely over HTTPS from anywhere
|
||||||
- **QR Code Generation**: Quickly connect mobile devices
|
- **QR Code Generation**: Quickly connect mobile devices
|
||||||
- **Real-time Sync**: WebSocket updates across all connected devices
|
- **Real-time Sync**: WebSocket updates across all connected devices
|
||||||
- **Offline Support**: PWA caches for offline macro viewing
|
- **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)
|
- pystray (System tray)
|
||||||
- netifaces (Network detection)
|
- netifaces (Network detection)
|
||||||
- qrcode (QR code generation)
|
- qrcode (QR code generation)
|
||||||
|
- aiohttp (Relay server client)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -136,6 +138,24 @@ The web interface provides full macro management:
|
|||||||
- **Show**: Restore window
|
- **Show**: Restore window
|
||||||
- **Quit**: Exit application
|
- **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
|
## Command Types Reference
|
||||||
|
|
||||||
| Type | Description | Parameters |
|
| Type | Description | Parameters |
|
||||||
@@ -213,6 +233,7 @@ MP-Server/
|
|||||||
├── config.py # Configuration constants
|
├── config.py # Configuration constants
|
||||||
├── macro_manager.py # Macro storage and execution
|
├── macro_manager.py # Macro storage and execution
|
||||||
├── web_server.py # FastAPI web server
|
├── web_server.py # FastAPI web server
|
||||||
|
├── relay_client.py # Relay server WebSocket client
|
||||||
├── pyproject.toml # Dependencies and build config
|
├── pyproject.toml # Dependencies and build config
|
||||||
├── gui/ # PySide6 desktop interface
|
├── gui/ # PySide6 desktop interface
|
||||||
│ ├── main_window.py
|
│ ├── main_window.py
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
0.9.0
|
1.0.0
|
||||||
|
|||||||
Reference in New Issue
Block a user