diff --git a/README.md b/README.md index 62f05f31..20c7b351 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ [![Download](https://img.shields.io/badge/Download-macOS-blue)](https://github.com/amantus-ai/vibetunnel/releases/latest) [![License](https://img.shields.io/badge/License-MIT-green)](LICENSE) [![macOS 14.0+](https://img.shields.io/badge/macOS-14.0+-red)](https://www.apple.com/macos/) +[![Apple Silicon](https://img.shields.io/badge/Apple%20Silicon-Required-orange)](https://support.apple.com/en-us/HT211814) ## Why VibeTunnel? @@ -15,6 +16,10 @@ Ever wanted to check on your AI agents while you're away? Need to monitor that l ## Quick Start +### Requirements + +**VibeTunnel requires an Apple Silicon Mac (M1+).** Intel Macs are not supported. + ### 1. Download & Install [Download VibeTunnel](https://github.com/amantus-ai/vibetunnel/releases/latest) and drag it to your Applications folder. @@ -49,6 +54,7 @@ Visit [http://localhost:4020](http://localhost:4020) to see all your terminal se - **📱 Mobile Ready** - Native iOS app and responsive web interface for phones and tablets - **🎬 Session Recording** - All sessions recorded in asciinema format for later playback - **⚡ High Performance** - Powered by Bun runtime for blazing-fast JavaScript execution +- **🍎 Apple Silicon Native** - Optimized for M1/M2/M3 Macs with ARM64-only binaries ## Architecture @@ -79,7 +85,7 @@ The server runs as a standalone Bun executable with embedded Node.js modules, pr ## Building from Source ### Prerequisites -- macOS 14.0+ (Sonoma) +- macOS 14.0+ (Sonoma) on Apple Silicon (M1/M2/M3) - Xcode 16.0+ - Node.js 20+ - Bun runtime diff --git a/mac/docs/RELEASE.md b/mac/docs/RELEASE.md index 7ec7202e..3d7798eb 100644 --- a/mac/docs/RELEASE.md +++ b/mac/docs/RELEASE.md @@ -269,7 +269,7 @@ VibeTunnel supports two update channels: ### Architecture Support VibeTunnel uses universal binaries that include both architectures: -- **Apple Silicon (arm64)**: Optimized for M1/M2/M3 Macs +- **Apple Silicon (arm64)**: Optimized for M1+ Macs - **Intel (x86_64)**: For Intel-based Macs The build system creates a single universal binary that works on all Mac architectures. This approach: