Update project documentation

Signed-off-by: Loren Eteval <loren.eteval@proton.me>
This commit is contained in:
Loren Eteval
2025-05-19 19:43:07 +08:00
parent 42bef651eb
commit 41f1f04139
+11 -7
View File
@@ -2,24 +2,28 @@
[![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)
A GUI proxy client based on PySide6. Support Xray-core & hysteria.
## Install
You can install from [release page](https://github.com/LorenEteval/Furious/releases) or
from [PyPI](https://pypi.org/project/Furious-GUI/).
> [!NOTE]
> For Linux users, PyPI is currently the only supported installation method.
## Wiki
* [TUN Mode](https://github.com/LorenEteval/Furious/wiki/TUN-Mode)
* [Install From PyPI](https://github.com/LorenEteval/Furious/wiki/Install-From-PyPI)
## License
License under [GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE).
* [TUN Mode](https://github.com/LorenEteval/Furious/wiki/TUN-Mode)
* [Subscription Management](https://github.com/LorenEteval/Furious/wiki/Subscription-Management)
## Credits
* [Xray-core](https://github.com/XTLS/Xray-core)
* [hysteria](https://github.com/apernet/hysteria)
* [tun2socks](https://github.com/xjasonlyu/tun2socks)
* [v2rayN](https://github.com/2dust/v2rayN)
* [QDarkStyleSheet](https://github.com/ColinDuquesnoy/QDarkStyleSheet)
## License
License under [GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE).