Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RPRX authored Mar 24, 2023
1 parent 82b0955 commit e23110f
Showing 1 changed file with 57 additions and 51 deletions.
108 changes: 57 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

[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).

[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)

## Document
## Documentation

[Project X](https://xtls.github.io/Xray-docs-next/config/)
[Project X Official Website](https://xtls.github.io)

## Telegram

Expand All @@ -19,22 +21,20 @@
## Installation

- Linux Script
- [Xray-install](https://github.com/XTLS/Xray-install) (Official)
- [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
- [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey)
- [Xray-script](https://github.com/kirin10000/Xray-script)
- [v2ray-agent](https://github.com/mack-a/v2ray-agent)
- [Xray-script](https://github.com/kirin10000/Xray-script)
- [Xray_onekey](https://github.com/wulabing/Xray_onekey)
- [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey)
- [Xray-yes](https://github.com/jiuqi9997/Xray-yes)
- [ProxySU](https://github.com/proxysu/ProxySU)
- Web Panel
- [X-UI](https://github.com/FranzKafkaYu/x-ui)
- [Hiddify](https://github.com/hiddify/hiddify-config)
- Tutorial
- [Xray Vision tutorial](https://github.com/chika0801/Xray-install)
- [Xray REALITY tutorial](https://cscot.pages.dev/2023/03/02/Xray-REALITY-tutorial/)
- Magisk
- [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk)
- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
Expand All @@ -44,49 +44,59 @@

## Usage

[Xray-examples](https://github.com/XTLS/Xray-examples) / [All-in-One-fallbacks-Nginx](https://github.com/XTLS/Xray-examples/tree/main/All-in-One-fallbacks-Nginx) / [VLESS-TCP-XTLS-Vision](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-Vision)

[chika0801's examples](https://github.com/chika0801/Xray-examples)

[lxhao61's examples](https://github.com/lxhao61/integrated-examples)
- 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

- Use Xray-core
- Windows
- [v2rayN](https://github.com/2dust/v2rayN)
- Android
- [v2rayNG](https://github.com/2dust/v2rayNG)
- Use [Clash Meta kernel](https://github.com/MetaCubeX/Clash.Meta)
- Windows
- [Clash Verge](https://github.com/zzzgydi/clash-verge)
- [clashN](https://github.com/2dust/clashN)
- Android
- [Clash Meta For Android](https://github.com/MetaCubeX/ClashMetaForAndroid)
- iOS
- [MFI](https://t.me/meta_for_ios)
- macOS
- [Clash Verge](https://github.com/zzzgydi/clash-verge)
- Linux
- [Clash Verge](https://github.com/zzzgydi/clash-verge)
- Use [sing-box](https://github.com/SagerNet/sing-box)
- Windows
- [NekoRay](https://github.com/MatsuriDayo/nekoray)
- Android
- [NekoBox](https://github.com/MatsuriDayo/NekoBoxForAndroid)
- iOS
- [SFI](https://sing-box.sagernet.org/zh/installation/clients/sfi/)
- OpenWrt
- [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2)
- [ShadowSocksR Plus+](https://github.com/fw876/helloworld)
- [PassWall](https://github.com/xiaorouji/openwrt-passwall)
- [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2)
- [luci-app-xray](https://github.com/yichya/luci-app-xray)
- iOS & macOS
- [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)
- [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient)
- Android
- [v2rayNG](https://github.com/2dust/v2rayNG)
- [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...

- iOS & macOS arm64
- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
- [Wings X](https://apps.apple.com/app/wings-x-client/id6446119727)
- [Stash](https://apps.apple.com/app/stash/id1596063349)
- macOS
- [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)
- [MFI](https://t.me/meta_for_ios)
- [sing-box](https://github.com/SagerNet/sing-box)
- [NekoBox For Android](https://github.com/MatsuriDayo/NekoBoxForAndroid)
- [SFI](https://sing-box.sagernet.org/zh/installation/clients/sfi/)

## Contributing

[Code of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md)

## Credits

Expand All @@ -108,10 +118,6 @@ This repo relies on the following third-party projects:
- [stretchr/testify](https://github.com/stretchr/testify)
- [h12w/socks](https://github.com/h12w/socks)


## Contributing
[Code Of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md)

## Compilation

### Windows
Expand Down

0 comments on commit e23110f

Please sign in to comment.