From 66e046af837feabfbf16fdfbd198ff8fc26dc8ff Mon Sep 17 00:00:00 2001
From: Diana Cl <135276904+Diana-Cl@users.noreply.github.com>
Date: Thu, 19 Sep 2024 17:32:44 +0330
Subject: [PATCH] Update README.md
---
README.md | 139 +++++++++++++++++++++++++++++++++---------------------
1 file changed, 85 insertions(+), 54 deletions(-)
diff --git a/README.md b/README.md
index 9c8b90a..a159efd 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,8 @@
-> **[🇮🇷Persian](README-fa.md)**
->
-> **[🇬🇧English](README.md)**
-
-
-
- 
-
-
-
- 
-
-
-
- 
-
+## $$\color{gold} \Huge \text{BPB v2.5.5}$$
-
- 
-
-
-
+> __[🇮🇷Persian](README-fa.md)__
+>
+> __[🇬🇧English](README.md)__
## Introduction
@@ -28,32 +11,41 @@ This project is dedicated to developing a user panel for the [Cloudflare-workers
HUGE THANKS TO
[bia pain bache](https://github.com/bia-pain-bache) for creating these amazing panel
-----
+---
+
+## table of contents
+- [Features](#Features)
+- [How to use](#How-to-use)
+- [Variable description](#Variable-description)
+- [Panel preview](#Panel-preview)
+- [Supported clients](#Supported-clients)
+
+---
The panel offers two deployment options:
-- **Worker** deployment
-- **Pages** deployment
+- __Worker__ deployment
+- __Pages__ deployment
## Features
-1. **Free**: No cost involved.
-2. **User-Friendly Panel:** Designed for easy navigation, configuration and usage.
-3. **Protocols:** Provides VLESS, Trojan and Wireguard (Warp) protocols.
-4. **Warp Pro configs:** Optimized Warp for crucial circumstances.
-5. **Support Fragment:** Supports Fragment functionality for crucial network situations.
-6. **Full routing rules:** Bypassing Iran/China and LAN, Blocking QUIC, Porn, Ads, Malwares, Phishing...
-5. **Bypass Iran and LAN (Optional)**
-6. **Full routing rules:** Bypassing Iran, Blocking Ads, Malwares, Phishing... for Sing-box.
-7. **Chain Proxy:** Capable of adding a chain proxy to fix IP.
-8. **Supports Wide Range of Clients:** Offers subscription links for Xray, Sing-box and Clash core clients.
-10. **Subscription Link (JSON):** Provides subscription link for JSON configs.
-11. **Password-Protected Panel:** Secure your panel with password protection.
-12. **Fully customizable:** Ability to use online scanner and setting up clean IP-domains, Proxy IP, setting DNS servers, choosing ports and protocols, Warp endpoints...
+1. __Free__: No cost involved.
+2. __User-Friendly Panel:__ Designed for easy navigation, configuration and usage.
+3. __Protocols:__ Provides VLESS, Trojan and Wireguard (Warp) protocols.
+4. __Warp Pro configs:__ Optimized Warp for crucial circumstances.
+5. __Support Fragment:__ Supports Fragment functionality for crucial network situations.
+6. __Full routing rules:__ Bypassing Iran/China and LAN, Blocking QUIC, Porn, Ads, Malwares, Phishing...
+5. __Bypass Iran and LAN (Optional)__
+6. __Full routing rules:__ Bypassing Iran, Blocking Ads, Malwares, Phishing... for Sing-box.
+7. __Chain Proxy:__ Capable of adding a chain proxy to fix IP.
+8. __Supports Wide Range of Clients:__ Offers subscription links for Xray, Sing-box and Clash core clients.
+10. __Subscription Link (JSON):__ Provides subscription link for JSON configs.
+11. __Password-Protected Panel:__ Secure your panel with password protection.
+12. __Fully customizable:__ Ability to use online scanner and setting up clean IP-domains, Proxy IP, setting DNS servers, choosing ports and protocols, Warp endpoints...
-## How to use:
+## How to use
- [Installation (Pages)](docs/pages_installation_fa.md)
- [Installation (Worker)](docs/worker_installation_fa.md)
@@ -66,24 +58,63 @@ HUGE THANKS TO
-## Supported Clients
+
+
+
+## Variable description
+> For further information on how to create variables, please refer to [this link](https://github.com/bia-pain-bache/BPB-Worker-Panel/blob/main/docs/pages_installation_fa.md#3--%D8%AA%D8%BA%DB%8C%DB%8C%D8%B1-%D9%BE%D8%B3%D9%88%D8%B1%D8%AF%D9%87%D8%A7%DB%8C-trojan).
+
+
+| Variable Name | Example | Required | Remark |
+|-----|----|--|------------|
+| UUID | `90cd4a77-141a-43c9-991b-08263cfe9c10` |✅| To generate your own UUID refer to [this link](https://www.uuidgenerator.net/) |
+| PROXYIP | `bpp.radically.pro` |❌| Alternative as a proxy node for accessing CloudFlareCDN site (supports multiple ProxyIPs, ex: ```['bpb.radically.pro', 'bpb.yousef.isegaro.com'];``` To find proxyIP [check here](https://github.com/NiREvil/vless/blob/main/sub/ProxyIP.md) |
+| TROJAN_PASS | `REvil` |✅| Your preferred password |
+| HASH_PASS | `6dfd0e8e67ad3230498f80938cb924bc767b7` |✅| Convert your preferred trojan password to SHA-224 Hash string to securely store password and verify data integrity, To performthis conversion refer to [this link](https://emn178.github.io/online-tools/sha224.html) |
+
+
+
+
+
+## Panel preview
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+---
+## Supported clients
+
| Client | Version | Fragment | Warp Pro |
| :-------------: | :-------------: | :-------------: | :-------------: |
-| **v2rayNG** | 1.8.19 or higher | :heavy_check_mark: | :x: |
-| **v2rayN** | 6.42 or higher | :heavy_check_mark: | :x: |
-| **v2rayN-PRO** | 1.4 or higher | :heavy_check_mark: | :heavy_check_mark: |
-| **Nekobox** | | :x: | :x: |
-| **Sing-box** | 1.8.10 or higher | :x: | :x: |
-| **Streisand** | | :heavy_check_mark: | :x: |
-| **V2Box** | | :x: | :x: |
-| **Shadowrocket** | | :x: | :x: |
-| **Nekoray** | | :heavy_check_mark: | :x: |
-| **Hiddify** | 2.0.5 or higher | :x: | :heavy_check_mark: |
-| **NikaNG** | | :heavy_check_mark: | :heavy_check_mark: |
-| **Clash Meta** | | :x: | :x: |
-| **Clash Verge Rev** | | :x: | :x: |
-| **FLClash** | | :x: | :x: |
-
+| __v2rayNG__ | 1.8.19 or higher | :heavy_check_mark: | :x: |
+| __v2rayN__ | 6.42 or higher | :heavy_check_mark: | :x: |
+| __v2rayN-PRO__ | 1.4 or higher | :heavy_check_mark: | :heavy_check_mark: |
+| __Nekobox__ | | :x: | :x: |
+| __Sing-box__ | 1.8.10 or higher | :x: | :x: |
+| __Streisand__ | | :heavy_check_mark: | :x: |
+| __V2Box__ | | :x: | :x: |
+| __Shadowrocket__ | | :x: | :x: |
+| __Nekoray__ | | :heavy_check_mark: | :x: |
+| __Hiddify__ | 2.0.5 or higher | :x: | :heavy_check_mark: |
+| __NikaNG__ | | :heavy_check_mark: | :heavy_check_mark: |
+| __Clash Meta__ | | :x: | :x: |
+| __Clash Verge Rev__ | | :x: | :x: |
+| __FLClash__ | | :x: | :x: |
---