From c6b78318cb5f3b596b9fbb06a48a8fdb83ba925d Mon Sep 17 00:00:00 2001 From: RPRX <63339210+RPRX@users.noreply.github.com> Date: Fri, 24 Mar 2023 22:57:56 +0000 Subject: [PATCH] Update README.md Co-authored-by: chika0801 <88967758+chika0801@users.noreply.github.com> Co-authored-by: yuhan6665 <1588741+yuhan6665@users.noreply.github.com> --- README.md | 89 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 62 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 7579cb91..77b6185e 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,99 @@ # Project X -[Project X](https://github.com/XTLS) originates from XTLS protocol, provides a set of network tools such as [Xray-core](https://github.com/XTLS/Xray-core). +[Project X](https://github.com/XTLS) originates from XTLS protocol, providing a set of network tools such as [Xray-core](https://github.com/XTLS/Xray-core) and [REALITY](https://github.com/XTLS/REALITY). + +[README](https://github.com/XTLS/Xray-core#readme) is open, so feel free to submit your project [here](https://github.com/XTLS/Xray-core/pulls). ## License [Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE) +## Documentation + +[Project X Official Website](https://xtls.github.io) + +## Telegram + +[Project X](https://t.me/projectXray) + +[Project X Channel](https://t.me/projectXtls) + ## Installation - Linux Script - - [Xray-install](https://github.com/XTLS/Xray-install) - - [Xray-script](https://github.com/kirin10000/Xray-script) + - [XTLS/Xray-install](https://github.com/XTLS/Xray-install) - Docker - [teddysun/xray](https://hub.docker.com/r/teddysun/xray) +- Web Panel + - [X-UI](https://github.com/FranzKafkaYu/x-ui), [X-UI-English](https://github.com/NidukaAkalanka/x-ui-english), [3X-UI](https://github.com/MHSanaei/3x-ui), [X-UI](https://github.com/alireza0/x-ui), [X-UI](https://github.com/diditra/x-ui) + - [Hiddify](https://github.com/hiddify/hiddify-config) + - [Marzban](https://github.com/Gozargah/Marzban) - One Click - - [ProxySU](https://github.com/proxysu/ProxySU) - - [v2ray-agent](https://github.com/mack-a/v2ray-agent) - - [Xray-yes](https://github.com/jiuqi9997/Xray-yes) - - [Xray_onekey](https://github.com/wulabing/Xray_onekey) + - [Xray-script](https://github.com/kirin10000/Xray-script), [Xray-script](https://github.com/zxcvos/Xray-script), [xray_script](https://github.com/tdjnodj/xray_script) + - [XTool](https://github.com/LordPenguin666/XTool), [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey), [xray-reality](https://github.com/sajjaddg/xray-reality) + - [v2ray-agent](https://github.com/mack-a/v2ray-agent), [Xray_onekey](https://github.com/wulabing/Xray_onekey), [ProxySU](https://github.com/proxysu/ProxySU) - Magisk - [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk) - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk) - Homebrew - `brew install xray` - [(Tap) Repository 0](https://github.com/N4FA/homebrew-xray) - - [(Tap) Repository 1](https://github.com/xiruizhao/homebrew-xray) - -## Contributing -[Code Of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md) ## Usage -[Xray-examples](https://github.com/XTLS/Xray-examples) / [VLESS-TCP-XTLS-WHATEVER](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-WHATEVER) +- Example + - [VLESS-XTLS-uTLS-REALITY](https://github.com/XTLS/REALITY#readme) + - [VLESS-TCP-XTLS-Vision](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-Vision) + - [All-in-One-fallbacks-Nginx](https://github.com/XTLS/Xray-examples/tree/main/All-in-One-fallbacks-Nginx) +- Xray-examples + - [XTLS/Xray-examples](https://github.com/XTLS/Xray-examples) + - [chika0801/Xray-examples](https://github.com/chika0801/Xray-examples) + - [lxhao61/integrated-examples](https://github.com/lxhao61/integrated-examples) +- Tutorial + - [XTLS Vision](https://github.com/chika0801/Xray-install) + - [REALITY (English)](https://cscot.pages.dev/2023/03/02/Xray-REALITY-tutorial/) ## GUI Clients - OpenWrt - - [PassWall](https://github.com/xiaorouji/openwrt-passwall) - - [Hello World](https://github.com/jerrykuku/luci-app-vssr) + - [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2) - [ShadowSocksR Plus+](https://github.com/fw876/helloworld) - [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray)) - Windows - [v2rayN](https://github.com/2dust/v2rayN) - - [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project had been archived and currently inactive) - - [Netch (NetFilter & TUN/TAP)](https://github.com/NetchX/Netch) (This project had been archived and currently inactive) + - [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient) - Android - [v2rayNG](https://github.com/2dust/v2rayNG) - - [Kitsunebi](https://github.com/rurirei/Kitsunebi/tree/release_xtls) -- iOS & macOS (with M1 chip) + - [X-flutter](https://github.com/XTLS/X-flutter) +- iOS & macOS arm64 + - [Mango](https://github.com/daemooon/Mango) + - [Wings X](https://apps.apple.com/app/wings-x/id6446119727) +- macOS arm64 & x64 + - [V2RayXS](https://github.com/tzmax/V2RayXS) + - [Wings X](https://apps.apple.com/app/wings-x/id6446119727) + +## Others that support VLESS, XTLS, REALITY, XUDP, PLUX... + +- iOS & macOS arm64 - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118) - [Stash](https://apps.apple.com/app/stash/id1596063349) -- macOS (Intel chip & M1 chip) - - [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project had been archived and currently inactive) - - [V2RayXS](https://github.com/tzmax/V2RayXS) +- API Wrapper + - [xtlsapi](https://github.com/hiddify/xtlsapi) +- [XrayR](https://github.com/XrayR-project/XrayR) + - [XrayR-release](https://github.com/XrayR-project/XrayR-release) + - [XrayR-V2Board](https://github.com/missuo/XrayR-V2Board) +- [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta) + - [Clash Verge](https://github.com/zzzgydi/clash-verge) + - [clashN](https://github.com/2dust/clashN) + - [Clash Meta for Android](https://github.com/MetaCubeX/ClashMetaForAndroid) + - [meta_for_ios](https://t.me/meta_for_ios) +- [sing-box](https://github.com/SagerNet/sing-box) + - [installReality](https://github.com/BoxXt/installReality) + - [sing-box-for-ios](https://github.com/SagerNet/sing-box-for-ios) + +## Contributing + +[Code of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md) ## Credits @@ -88,12 +129,6 @@ go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main ``` -## Telegram - -[Project X](https://t.me/projectXray) - -[Project X Channel](https://t.me/projectXtls) - ## Stargazers over time [![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)