Skip to content

Commit 70f40f1

Browse files
committed
update docs
1 parent f5effba commit 70f40f1

2 files changed

Lines changed: 64 additions & 16 deletions

File tree

README.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
88
[![Go](https://img.shields.io/badge/Go-1.26-00ADD8?logo=go&logoColor=white)](agent/go.mod)
9+
[![Swift](https://img.shields.io/badge/Swift-6.3-F05138?logo=swift&logoColor=white)](agent-mac/)
910
[![Node.js](https://img.shields.io/badge/Node.js-24+-339933?logo=node.js&logoColor=white)](packages/relay/package.json)
1011
[![React](https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=black)](packages/web/package.json)
1112
[![Docker](https://img.shields.io/badge/Docker-ready-2496ED?logo=docker&logoColor=white)](Dockerfile)
@@ -106,14 +107,37 @@ The agent is a single Go binary that runs on your local machines.
106107
107108
Go to the [Releases](https://github.com/finch-xu/RemoteTTYs/releases) page and download the binary for your platform:
108109
109-
| Platform | File |
110-
|----------|------|
111-
| **macOS menu bar app (recommended)** ⭐ | `RttysAgent.zip` |
112-
| macOS CLI (Apple Silicon) | `rttys-agent-macOS-arm64` |
113-
| macOS CLI (Intel) | `rttys-agent-macOS-x64` |
114-
| Linux (x86_64) | `rttys-agent-Linux-x64` |
115-
| Linux (ARM64) | `rttys-agent-Linux-arm64` |
116-
| Windows (x86_64) | `rttys-agent-Windows-x64.exe` |
110+
<table>
111+
<tr>
112+
<td rowspan="7" align="center"><img src="images/rttys-agent-logo-rounded.png" width="160" /></td>
113+
<th>Platform</th>
114+
<th>File</th>
115+
</tr>
116+
<tr>
117+
<td><b>macOS menu bar app (recommended)</b> ⭐</td>
118+
<td><code>RttysAgent.zip</code></td>
119+
</tr>
120+
<tr>
121+
<td>macOS CLI (Apple Silicon)</td>
122+
<td><code>rttys-agent-macOS-arm64</code></td>
123+
</tr>
124+
<tr>
125+
<td>macOS CLI (Intel)</td>
126+
<td><code>rttys-agent-macOS-x64</code></td>
127+
</tr>
128+
<tr>
129+
<td>Linux (x86_64)</td>
130+
<td><code>rttys-agent-Linux-x64</code></td>
131+
</tr>
132+
<tr>
133+
<td>Linux (ARM64)</td>
134+
<td><code>rttys-agent-Linux-arm64</code></td>
135+
</tr>
136+
<tr>
137+
<td>Windows (x86_64)</td>
138+
<td><code>rttys-agent-Windows-x64.exe</code></td>
139+
</tr>
140+
</table>
117141
118142
**macOS menu bar app:** unzip and drag `RttysAgent.app` to `/Applications`. Launching it adds a menu bar icon with live connection status, log viewer, and a built-in config editor — no terminal commands needed. Universal binary (arm64 + x86_64), Developer ID signed, notarized, and self-updates via [Sparkle](https://sparkle-project.org/). If you install the app, skip sections 2–3 below and configure via the menu bar UI instead.
119143

README.zh-CN.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
88
[![Go](https://img.shields.io/badge/Go-1.26-00ADD8?logo=go&logoColor=white)](agent/go.mod)
9+
[![Swift](https://img.shields.io/badge/Swift-6.3-F05138?logo=swift&logoColor=white)](agent-mac/)
910
[![Node.js](https://img.shields.io/badge/Node.js-24+-339933?logo=node.js&logoColor=white)](packages/relay/package.json)
1011
[![React](https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=black)](packages/web/package.json)
1112
[![Docker](https://img.shields.io/badge/Docker-ready-2496ED?logo=docker&logoColor=white)](Dockerfile)
@@ -106,14 +107,37 @@ Agent 是一个单文件 Go 二进制,运行在你的本地机器上。
106107
107108
前往 [Releases](https://github.com/finch-xu/RemoteTTYs/releases) 页面,下载对应平台的二进制文件:
108109
109-
| 平台 | 文件名 |
110-
|------|--------|
111-
| **macOS 菜单栏应用(推荐)** ⭐ | `RttysAgent.zip` |
112-
| macOS CLI (Apple Silicon) | `rttys-agent-macOS-arm64` |
113-
| macOS CLI (Intel) | `rttys-agent-macOS-x64` |
114-
| Linux (x86_64) | `rttys-agent-Linux-x64` |
115-
| Linux (ARM64) | `rttys-agent-Linux-arm64` |
116-
| Windows (x86_64) | `rttys-agent-Windows-x64.exe` |
110+
<table>
111+
<tr>
112+
<td rowspan="7" align="center"><img src="images/rttys-agent-logo-rounded.png" width="160" /></td>
113+
<th>平台</th>
114+
<th>文件名</th>
115+
</tr>
116+
<tr>
117+
<td><b>macOS 菜单栏应用(推荐)</b> ⭐</td>
118+
<td><code>RttysAgent.zip</code></td>
119+
</tr>
120+
<tr>
121+
<td>macOS CLI (Apple Silicon)</td>
122+
<td><code>rttys-agent-macOS-arm64</code></td>
123+
</tr>
124+
<tr>
125+
<td>macOS CLI (Intel)</td>
126+
<td><code>rttys-agent-macOS-x64</code></td>
127+
</tr>
128+
<tr>
129+
<td>Linux (x86_64)</td>
130+
<td><code>rttys-agent-Linux-x64</code></td>
131+
</tr>
132+
<tr>
133+
<td>Linux (ARM64)</td>
134+
<td><code>rttys-agent-Linux-arm64</code></td>
135+
</tr>
136+
<tr>
137+
<td>Windows (x86_64)</td>
138+
<td><code>rttys-agent-Windows-x64.exe</code></td>
139+
</tr>
140+
</table>
117141
118142
**macOS 菜单栏应用:** 解压后把 `RttysAgent.app` 拖进 `/Applications`。启动后顶部菜单栏会出现状态图标,提供连接状态显示、日志查看和内置配置编辑器 — 全程无需终端命令。通用二进制(arm64 + x86_64),Developer ID 签名并经 Apple 公证,内置 [Sparkle](https://sparkle-project.org/) 自动更新。使用菜单栏应用时,下方第 2、3 步可跳过,直接在菜单栏 UI 中完成配置。
119143

0 commit comments

Comments
 (0)