diff --git a/README.md b/README.md index 61e2834..77d6828 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,38 @@ [![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) -A GUI proxy client based on PySide6. Support Xray-core & hysteria. +A cross‑platform GUI proxy client based on PySide6. Support Xray-core & hysteria. + +--- + +## Features + +* 🖥️ **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 [release page](https://github.com/LorenEteval/Furious/releases) or -from [PyPI](https://pypi.org/project/Furious-GUI/). +You can install from the **[GitHub Releases](https://github.com/LorenEteval/Furious/releases)** page or directly from **PyPI**. -### winget (Windows only) +### 🪟 winget (Windows only) ``` winget install --id=LorenEteval.Furious -e ``` -### PyPI +### 🐍 PyPI ``` pip install Furious-GUI @@ -24,9 +41,9 @@ pip install Furious-GUI ## Wiki -* [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) +* 🌐 [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) ## Contributing @@ -38,8 +55,31 @@ pip install Furious-GUI * [hysteria](https://github.com/apernet/hysteria) * [tun2socks](https://github.com/xjasonlyu/tun2socks) -[@rakleed](https://github.com/rakleed) for adding Windows package to winget. +Special thanks to [@rakleed](https://github.com/rakleed) for adding the Windows package to winget. + +--- + +## Donations + +As a fully cross-platform client, Furious requires continuous development and testing across **Windows**, **macOS** and +**Linux**. All feature design, implementation, debugging, polishing and release engineering are done end‑to‑end by me. + +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 + + ## License -License under [GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE). +Licensed under **[GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE)**.