diff --git a/README.md b/README.md index 4288b05..aa9775c 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,44 @@ # Furious -[![Github Deploy](https://github.com/LorenEteval/Furious/actions/workflows/deploy-pypi.yml/badge.svg?branch=main)](https://github.com/LorenEteval/Furious/actions/workflows/deploy-pypi.yml) -[![winget](https://img.shields.io/badge/winget-Available-brightgreen?logo=windows)](https://winstall.app/apps/LorenEteval.Furious) -[![release](https://img.shields.io/github/v/release/LorenEteval/Furious)](https://github.com/LorenEteval/Furious/releases) -[![license](https://img.shields.io/github/license/LorenEteval/Furious)](https://github.com/LorenEteval/Furious/blob/main/LICENSE) +[![Build and release](https://github.com/LorenEteval/Furious/actions/workflows/deploy-pypi.yml/badge.svg?branch=main)](https://github.com/LorenEteval/Furious/actions/workflows/deploy-pypi.yml) +[![Latest release](https://img.shields.io/github/v/release/LorenEteval/Furious)](https://github.com/LorenEteval/Furious/releases) +[![License](https://img.shields.io/github/license/LorenEteval/Furious)](https://github.com/LorenEteval/Furious/blob/main/LICENSE) -A crossโ€‘platform GUI proxy client based on PySide6. Support Xray-core & hysteria. +A GUI client based on PySide6. Support Xray-core & hysteria. ---- +## Installation -## Features +Download a packaged build from [GitHub Releases](https://github.com/LorenEteval/Furious/releases). This is the +recommended option for most users. -* ๐Ÿ–ฅ๏ธ **Crossโ€‘platform** โ€” Runs on **Windows**, **macOS** and **Linux** -* โš™๏ธ **Builtโ€‘in Support For Xray-core & Hysteria** โ€” Shipped as Python bindings for convenience -* ๐Ÿ”— **Protocol Support** โ€” VLESS, VMess, Shadowsocks, Trojan, hysteria1 & hysteria2 -* ๐ŸŒ **TUN Mode Support** โ€” Available on Windows, macOS and Linux -* ๐Ÿ“ **Integrated configuration editor** โ€” Fully editable configuration UI -* ๐Ÿ”„ **Subscription management** โ€” Add, update or schedule refreshes -* ๐Ÿ”Œ **Client UX** โ€” Oneโ€‘click Connect / Disconnect -* ๐Ÿ“ฅ **Import** via share link, JSON, or QR Code -* ๐Ÿ“ค **Export** as share link, JSON, or QR Code -* ๐Ÿ”“ **Open-source & Reproducible Builds** -* ... - -## Install - -You can install from the **[GitHub Releases](https://github.com/LorenEteval/Furious/releases)** page or directly from **PyPI**. - -### ๐ŸชŸ winget (Windows only) +Windows users can also install Furious with WinGet: ``` winget install --id=LorenEteval.Furious -e ``` -### ๐Ÿ PyPI +For a Python environment, install the `Furious-GUI` package: ``` pip install Furious-GUI ``` -## Wiki +See [Install from PyPI](https://github.com/LorenEteval/Furious/wiki/Install-From-PyPI) for compatibility and launch +details. -* ๐ŸŒ [TUN Mode](https://github.com/LorenEteval/Furious/wiki/TUN-Mode) -* ๐Ÿ”„ [Subscription Management](https://github.com/LorenEteval/Furious/wiki/Subscription-Management) -* ๐Ÿ“ฆ [Install From PyPI](https://github.com/LorenEteval/Furious/wiki/Install-From-PyPI) +## Documentation -### Windows TUN (`wintun.dll`) - -The Windows release is **amd64 (x64)** only. The [official Wintun](https://www.wintun.net/) package ships **one `wintun.dll` per CPU architecture** under `wintun\bin\` (for example `amd64`, `arm`, `arm64`, and `x86`). - -You must use the DLL from **`wintun\bin\amd64\wintun.dll`**. Loading a DLL from another architecture (for example `arm64` or `x86`) can **crash TUN mode**. - -Full setup (including where to place the file and administrator steps) is documented in **[TUN Mode](https://github.com/LorenEteval/Furious/wiki/TUN-Mode)**. - -## Contributing - -[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/LorenEteval/Furious) +See the [Wiki](https://github.com/LorenEteval/Furious/wiki) for complete documentation. Start with +the [Quick Start](https://github.com/LorenEteval/Furious/wiki/Quick-Start), or +consult [Troubleshooting and Diagnostics](https://github.com/LorenEteval/Furious/wiki/Troubleshooting-and-Diagnostics) +when something goes wrong. ## Credits -* [Xray-core](https://github.com/XTLS/Xray-core) -* [hysteria](https://github.com/apernet/hysteria) -* [tun2socks](https://github.com/xjasonlyu/tun2socks) - -Special thanks to [@rakleed](https://github.com/rakleed) for adding the Windows package to winget. - ---- - -## Donations - -If you find this project useful, donations are warmly appreciated. They help sustain development, testing and future -improvements. - -* BTC: `12Yp5Ffr6sXR5Ha5h43FnGW4RSCQeeJeUG` -* TRC20/TRON (USDT, TRON, ...): `TVHKXJq6S5cWzLwa7tLf6LoYB3T9ftiFkN` - -## Star History - - - - - - Star History Chart - - +- [Xray-core](https://github.com/XTLS/Xray-core) +- [Hysteria](https://github.com/apernet/hysteria) +- [tun2socks](https://github.com/xjasonlyu/tun2socks) ## License -Licensed under **[GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE)**. +License under the [GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE).