From 321c56a52b9aff28fd419b81a01ec9212bf1eedf Mon Sep 17 00:00:00 2001 From: Loren Eteval Date: Fri, 11 Aug 2023 18:57:27 +0800 Subject: [PATCH] Update project documentation Signed-off-by: Loren Eteval --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2b8eda3..f120639 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ and [hysteria](https://github.com/apernet/hysteria). * Support import from JSON or share link(`vmess://...`, `vless://...` or `ss://`, including the newest [REALITY](https://github.com/XTLS/REALITY) share standard). * Support export to JSON, share link or QRCode. -* Two built-in routing mode support: Bypass Mainland China(with Ads filter) and Global. You can also choose to use your - own routing rules. +* Built-in routing mode support: Bypass Mainland China(with Ads filter), Bypass Iran(with Ads filter) and Global. You + can also choose to customize your own routing rules. * Built-in editor support. * VPN-client user experience. * Support system theme detection and switch to dark/light theme automatically. @@ -74,6 +74,8 @@ must have tools ready for building these bindings for your current platform firs ### Install Furious +> Note: Install Furious in a Python virtual environment(i.e. venv) is recommended. + Furious requires **Python 3.8 and above**. ``` @@ -95,6 +97,8 @@ Furious will enable startup on boot by default if it's launched for the first ti Clone this repository and enter the project folder. Install requirements: +> Note: Install requirements in a Python virtual environment(i.e. venv) is recommended. + > Note: To install requirements successfully you will also need > those [Core Building Tools](https://github.com/LorenEteval/Furious#core-building-tools) above.