Merge pull request #125 from QIN2DIM/main

Update: add `NekoRay` quick-start documentation @QIN2DIM

md/client.md

@@ -81,8 +81,148 @@ v2rayN已经在添加自定义配置时支持hysteria并能自动识别config的
 ## 5. openclash
 待补充或者请您提交pr
 
-## 6. nekoray
-待补充或者请您提交pr
+## 6. NekoRay
+
+**目录**
+
+- [6.0 项目简介](#nekoray-intro)
+- [6.1 下载 NekoRay](#nekoray-download-client)
+- [6.2 下载 hysteria-core-windows](#nekoray-download-hysteria-core)
+- [6.3 配置 NekoRay 代理核心](#nekoray-set-kernel)
+- [6.4 导入 hysteria 节点](#nekoray-import-nodes)
+- [6.4.1 从分享链接或剪切板添加](#nekoray-import-nodes-by-sharelink)
+- [6.4.2 手动编辑](#nekoray-import-nodes-by-myself)
+- [6.5 启动 hysteria 节点](#nekoray-setup-hysteria-proxy)
+- [6.6 [选读]测试 hysteria 节点](#nekoray-test-hysteria-proxy)
+- [参考资料](#nekoray-reference)
+
+<span id="nekoray-intro"></span>
+### 6.0 项目简介
+
+[NekoRay](https://github.com/MatsuriDayo/nekoray) —— 基于 Qt/C++ 的跨平台代理配置管理器，是一个仍处于成长期的开源项目。NekoRay 先于 V2rayN 支持了 `hysteria://` 协议头的解析，玩家可通过节点分享链接批量导入 hysteria 节点。此外，NekoRay 巧妙地实现了「节点激活 + 节点测试」的 action 集成交互，可以基于组的形式管理和测试 hysteria 节点而无需手动配置 socks5 监听器。
+
+NekoRay 目前支持 Windows / Linux amd64。下文以 NekoRay v1.5 Windows 为例介绍客户端的快速入坑步骤。
+
+<span id="nekoray-download-client"></span>
+### 6.1 下载 NekoRay
+
+进入 [Releases · MatsuriDayo/nekoray](https://github.com/MatsuriDayo/nekoray/releases)，下载最新版的 NekoRay Windows 压缩包。免安装，开箱即用。此处假设解压目录为 `C:\\nekoray`，则主程序路径为 `C:\\nekoray\\nekoray.exe`。
+
+<span id="nekoray-download-hysteria-core"></span>
+### 6.2 下载 hysteria-core-windows
+
+进入 [Releases · HyNetwork/hysteria](https://github.com/HyNetwork/hysteria/releases)，下载最新版的 `hysteria-windows-amd64.exe`，将其放置在解压后的 NekoRay 配置目录下，例如：`C:\\nekoray\\config\\hysteria-windows-amd64.exe`（此处随意，但 **config** 为核心界面的默认启动路径，这样放置方面找文件）。
+
+<span id="nekoray-set-kernel"></span>
+### 6.3 配置 NekoRay 代理核心
+
+依次进入「首选项」「基本设置」「核心」界面，选择 **hysteria-core** 的绝对路径，即刚下载的 `hysteria-windows-amd64.exe` 文件绝对路径。
+
+选定后切换到「基本设置 - 通用」界面，**将 HTTP 监听端口启用**。其他设置保持默认，点击确定，保存设置。相关步骤如下图所示：
+
+<p align="center">
+<img width="75%" src="https://user-images.githubusercontent.com/62018067/187100719-47d2986b-6ef4-4996-8561-d7f17b491747.png"/>
+</p>
+
+<span id="nekoray-import-nodes"></span>
+### 6.4 导入 hysteria 节点
+
+<span id="nekoray-import-nodes-by-sharelink"></span>
+#### 6.4.1 从分享链接或剪切板添加
+
+NekoRay 支持 `hysteria://` 协议头的解析，可以直接将订阅链接粘贴进来自动获取节点的配置信息，如下图所示:
+
+<p align="center">
+<img width="75%" src="https://user-images.githubusercontent.com/62018067/187100758-65941f04-b87d-4cbd-80f5-800c157eb1bc.png"/>
+</p>
+
+<span id="nekoray-import-nodes-by-myself"></span>
+
+#### 6.4.2 手动编辑
+
+相关配置的注释及生成后的面板预览结果如下图所示：
+<p align="center">
+<img width="75%" src="https://user-images.githubusercontent.com/62018067/187100799-9b7a7cdd-70c8-4443-ba22-928224e86ae2.png"/>
+</p>
+
+<p align="center">
+<img width="75%" src="https://user-images.githubusercontent.com/62018067/187100811-f5ff59c4-27f6-44f4-b0c2-587da662bd09.png"/>
+</p>
+
+此处出现了被称为 `替换串` 的占位符，即 `%mapping_port%` 与 `%socks_port%`，不需要修改，保持默认即可。
+
+<span id="nekoray-setup-hysteria-proxy"></span>
+
+### 6.5 启动 hysteria 节点
+
+初次使用时，选中目标节点，并依次点击「程序 – 系统代理 – 启动系统代理」。当控制台开始持续输出来自 hysteria-core 的日志信息时，说明节点启动成功，你可以访问 Google 或 Youtube 等站点进行行为校验。
+
+<p align="center">
+<img width="75%" src="https://user-images.githubusercontent.com/62018067/187100876-b8afceba-1af9-4012-a20d-b6ab3dfc32ae.png"/>
+</p>
+
+值得一提的是，NekoRay 的<系统代理启动>及<代理核心运行>的业务是分离的，也即对着节点敲回车的作用是启动/重启代理核心，只有勾选「启动系统代理」后才能连接互联网，这点与 V2rayN 相似。
+
+<span id="nekoray-test-hysteria-proxy"></span>
+
+### 6.6 [选读]测试 hysteria 节点
+
+在合理配置前置代理选项后，你可以将「节点激活 + 节点测试」集成到一个 action 中，这比 V2rayN 目前(~v5.32)的解决方案要更加优雅。
+
+若你按照本文档介绍的步骤走，你只需要在默认分组状态下，依次点击「服务器 – 当前分组」即可调出测试控件的接口，如下图所示：
+<p align="center">
+<img width="30%" src="https://user-images.githubusercontent.com/62018067/187101054-ae6fc4d9-b474-4dde-887d-7e604ef40618.png"/>
+</p>
+
+NekoRay 集成了一些主流的测试工具，直接运行「完整测试」即可。测试包含以下四个项目（点击跳转源码）：
+
+<div align="center">
+<table style="border: 2px #000000 groove">
+	<thead>
+		<tr>
+			<th style="border: 2px #000000 groove">测试项目</th>
+			<th style="border: 2px #000000 groove">简介</th>
+		</tr>
+	</thead>
+	<tbody>
+		<tr>
+			<td style="border: 2px #000000 groove"><a href="https://github.com/MatsuriDayo/nekoray/blob/4ed46c10feef17831398d7daf5829e01b446d3f5/go/grpc_core.go#L204">Latency 延迟测试</a></td>
+			<td style="border: 2px #000000 groove"></td>
+		</tr>
+		<tr>
+			<td style="border: 2px #000000 groove"><a href="https://github.com/MatsuriDayo/nekoray/blob/4ed46c10feef17831398d7daf5829e01b446d3f5/go/grpc_core.go#L247">下载速度测试</a></td>
+			<td style="border: 2px #000000 groove">使用代理下载 10MiB 文件，计算下载速度。</td>
+		</tr>
+		<tr>
+			<td style="border: 2px #000000 groove">
+        <a href="https://github.com/MatsuriDayo/nekoray/blob/4ed46c10feef17831398d7daf5829e01b446d3f5/go/grpc_core.go#L216">入口IP</a>，
+        <a href="https://github.com/MatsuriDayo/nekoray/blob/4ed46c10feef17831398d7daf5829e01b446d3f5/go/grpc_core.go#L229">出口IP</a>
+      </td>
+			<td style="border: 2px #000000 groove"></td>
+		</tr>
+		<tr>
+			<td style="border: 2px #000000 groove"><a href="https://github.com/MatsuriDayo/nekoray/blob/4ed46c10feef17831398d7daf5829e01b446d3f5/go/grpc_core.go#L263">NAT类型</a></td>
+			<td style="border: 2px #000000 groove"></td>
+		</tr>
+	</tbody>
+</table>
+</div>
+
+测试的输出结果如下图所示：
+
+<p align="center">
+<img width="75%" src="https://user-images.githubusercontent.com/62018067/187101128-8bbc47ee-2027-4fc5-90a5-43eb08209a1c.png"/>
+</p>
+
+我们在经典的 hysteria 代理拓扑中使用的是最简单的 QUIC 直连方案，也即入口地址 In 和出口地址 Out 是相同的，其值均为你的代理服务器的真实 IP。
+
+需要注意的是，hysteria 是基于 quic-go 实现的通信协议，TCPing 测试不可用。
+
+<span id="nekoray-reference"></span>
+
+### 参考资料
+
+1. [Nekoray-配置 - Matsuri & NekoRay](https://matsuridayo.github.io/n-configuration/)
 
 ## 7. shadowrocket
 没有IOS，请提交pr此项