From 10a4221b250cc36b6b91d75ee724365c13c90924 Mon Sep 17 00:00:00 2001 From: JieXu Date: Wed, 1 Jul 2026 20:20:39 +0800 Subject: [PATCH] Update README.md (#5852) * Update README.md * Update build.yml * Update README.md --- .github/workflows/build.yml | 2 +- README.md | 84 +++++++++++++++++++++++++++++++------ 2 files changed, 72 insertions(+), 14 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e59e563d..eb064b77 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -144,7 +144,7 @@ jobs: gpg --batch --yes --local-user "$KEY" --detach-sign --output "release-files/$(basename "$apk").sig" "$apk" done - gpg --armor --export "$KEY" > release-files/v2rayNG-public-key.asc + gpg --armor --export "$KEY" > release-files/v2rayN-public-key.asc - name: Upload APKs, signatures and public key to release uses: svenstaro/upload-release-action@v2 diff --git a/README.md b/README.md index 9ce378f0..af8085ff 100644 --- a/README.md +++ b/README.md @@ -9,24 +9,82 @@ A V2Ray client for Android, support [Xray core](https://github.com/XTLS/Xray-cor [![GitHub Releases](https://img.shields.io/github/downloads/2dust/v2rayNG/latest/total?logo=github)](https://github.com/2dust/v2rayNG/releases) [![Chat on Telegram](https://img.shields.io/badge/Chat%20on-Telegram-brightgreen.svg)](https://t.me/v2rayn) -### Telegram Channel -[github_2dust](https://t.me/github_2dust) +--- -### Usage +## Download / 下载 + +Download the latest release here: + +在这里下载最新版本： + +[https://github.com/2dust/v2rayNG/releases](https://github.com/2dust/v2rayNG/releases) + +> [!TIP] +> v2rayNG is the mobile version. For the desktop version, please visit the v2rayN \ +> v2rayNG 是手机版，电脑版请访问 v2rayN +> +> https://github.com/2dust/v2rayN + +--- + +### Geoip and Geosite -#### Geoip and Geosite - geoip.dat and geosite.dat files are in `Android/data/com.v2ray.ang/files/assets` (path may differ on some Android device) -- download feature will get enhanced version in this [repo](https://github.com/Loyalsoldier/v2ray-rules-dat) (Note it need a working proxy) +- download feature will get enhanced version in this [repo](https://github.com/Loyalsoldier/v2ray-rules-dat) (note: it needs a working proxy) - latest official [domain list](https://github.com/Loyalsoldier/v2ray-rules-dat) and [ip list](https://github.com/Loyalsoldier/geoip) can be imported manually -- possible to use third party dat file in the same folder, like [h2y](https://guide.v2fly.org/routing/sitedata.html#%E5%A4%96%E7%BD%AE%E7%9A%84%E5%9F%9F%E5%90%8D%E6%96%87%E4%BB%B6) +- possible to use a third-party dat file in the same folder, like [h2y](https://guide.v2fly.org/routing/sitedata.html#%E5%A4%96%E7%BD%AE%E7%9A%84%E5%9F%9F%E5%90%8D%E6%96%87%E4%BB%B6) -### More in our [wiki](https://github.com/2dust/v2rayNG/wiki) +More in our [wiki](https://github.com/2dust/v2rayNG/wiki) -### Development guide +### Geoip 与 Geosite -Android project under V2rayNG folder can be compiled directly in Android Studio, or using Gradle wrapper. But the v2ray core inside the aar is (probably) outdated. -The aar can be compiled from the Golang project [AndroidLibV2rayLite](https://github.com/2dust/AndroidLibV2rayLite) or [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite). -For a quick start, read guide for [Go Mobile](https://github.com/golang/go/wiki/Mobile) and [Makefiles for Go Developers](https://tutorialedge.net/golang/makefiles-for-go-developers/) +- geoip.dat 和 geosite.dat 文件位于 `Android/data/com.v2ray.ang/files/assets`（部分设备路径可能不同） +- 下载功能将获取该 [仓库](https://github.com/Loyalsoldier/v2ray-rules-dat) 中的增强版本（注意：此功能需要一个可用的代理） +- 最新官方 [域名列表](https://github.com/Loyalsoldier/v2ray-rules-dat) 和 [IP 列表](https://github.com/Loyalsoldier/geoip) 可手动导入 +- 也可在同一文件夹中使用第三方 dat 文件，例如 [h2y](https://guide.v2fly.org/routing/sitedata.html#%E5%A4%96%E7%BD%AE%E7%9A%84%E5%9F%9F%E5%90%8D%E6%96%87%E4%BB%B6) -v2rayNG can run on Android Emulators. For WSA, VPN permission need to be granted via -`appops set [package name] ACTIVATE_VPN allow` +更多内容请见我们的 [wiki](https://github.com/2dust/v2rayNG/wiki) + +--- + +## Development guide / 开发指南 + +### Note + +- Android project under the V2rayNG folder can be compiled directly in Android Studio, or using the Gradle wrapper. But the v2ray core inside the aar is (probably) outdated. +- The aar can be compiled from the Golang project [AndroidLibV2rayLite](https://github.com/2dust/AndroidLibV2rayLite) or [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite). For a quick start, read the guides for [Go Mobile](https://github.com/golang/go/wiki/Mobile) and [Makefiles for Go Developers](https://tutorialedge.net/golang/makefiles-for-go-developers/). +- v2rayNG can run on Android Emulators. For WSA, VPN permission needs to be granted via `appops set [package name] ACTIVATE_VPN allow`. + +### 提示 + +- V2rayNG 文件夹下的 Android 项目可直接在 Android Studio 中编译，或使用 Gradle wrapper 编译。但 aar 内置的 v2ray core（可能）已过时。 +- aar 可由 Golang 项目 [AndroidLibV2rayLite](https://github.com/2dust/AndroidLibV2rayLite) 或 [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite) 编译而成。快速入门可参考 [Go Mobile](https://github.com/golang/go/wiki/Mobile) 指南和 [Makefiles for Go Developers](https://tutorialedge.net/golang/makefiles-for-go-developers/)。 +- v2rayNG 可在 Android 模拟器上运行。对于 WSA，需要通过 `appops set [package name] ACTIVATE_VPN allow` 授予 VPN 权限。 + +--- + + +## GPG Verification / GPG 签名校验 + +Release files are signed with GPG to verify authenticity and integrity, helping prevent mirror, ISP, or CDN hijacking. + +发布文件已使用 GPG 签名，可用于校验文件真实性与完整性，预防镜像站、运营商或 CDN 劫持。 + +### Fingerprint / 公钥指纹 + +```text +7694 5E9F 3E9A 168F 8070 F195 805D 661C +134D FAF6 8903 C199 463C 31E5 AE90 3AE0 +``` + +--- + +## Community / 社区 + +Telegram Group / Telegram 群组： + +[https://t.me/v2rayN](https://t.me/v2rayN) + +Telegram Channel / Telegram 频道： + +[https://t.me/github_2dust](https://t.me/github_2dust)