You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-20Lines changed: 17 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,31 +3,31 @@
3
3
<h1>Marz - An <ahref="https://github.com/xtls/xray-core">Xray</a>-based VPN client</h1>
4
4
</div>
5
5
6
-
6
+
<palign='center'>
7
7
Marz is an Xray client that aims for a clean and intuitive interface. The repo distributes APKs for now. iOS and macOS ports are planned once the Android release stabilizes.
-**Smart Server Selection** — Automatic fastest-server detection with instant failover
15
-
-**Subscription Based** — Easy import and parsing of v2ray/Xray subscription links with usage tracking
16
-
-**Usage Monitoring** — Track upload, download, and remaining data with visual progress indicators
17
-
-**Expiration Alerts** — Proactive in-app notifications when subscriptions approach expiration or data limits
18
-
-**Geo-IP Display** — View current IP and location through the active proxy
19
-
-**Quick Settings Tile** — Fast toggle access directly from Android's Quick Settings panel
20
-
-**Background Operation** — Lightweight background connectivity with persistent connection state
21
-
-**Multiple Locations** — Support for managing multiple subscription profiles with quick switching
15
+
- Automatic fastest-server selection with instant failover
16
+
-Import and parse v2ray/Xray subscription links with usage tracking
17
+
-Upload, download, and remaining data at a glance
18
+
- Alerts when your subscription is close to expiring or hitting its data cap
19
+
-Shows your current IP and location through the active proxy
20
+
- Quick Settings tile for fast toggling
21
+
- Lightweight background operation that stays out of your way
22
+
- Multiple subscription profiles with quick switching
22
23
23
24
24
25
### Who Marz Is For
25
26
26
27
27
28
Marz is designed for non-technical users who need a simple, reliable way to connect using Xray-based subscription links. The application intentionally omits advanced technical options to keep the interface approachable for everyday users. Users seeking custom protocol settings, routing rules, or detailed debugging capabilities should consider established tools like [V2rayNG](https://github.com/2dust/v2rayNG). Marz starts Xray based on the provided subscription link and manages the connection without exposing complex settings.
28
29
29
-
Most Xray clients aim to give users full control over their connections with a comprehensive interface. Marz takes a different approach — a simple, VPN-like experience that just works.
30
-
30
+
Most Xray clients aim to give users full control over their connections with a comprehensive interface. Marz just parses the subscription link and prepares it for a smooth connection.
31
31
32
32
33
33
### Platform Availability
@@ -40,7 +40,7 @@ iOS and macOS builds are planned after the Android release reaches a stable mile
40
40
41
41
## Deep Linking Guide
42
42
43
-
Marz supports deep linking to enable one-tap subscription imports from provider websites.
43
+
One-tap subscription import from provider websites:
- Include country flag emojis in config remarks (e.g., `🇺🇸 US-1`, `🇬🇧 London`) for automatic geographic grouping in the app.
61
-
- Configs without a recognizable country flag in remarks may not appear as reachable servers.
60
+
- Add country flag emojis to config remarks (e.g. `🇺🇸 US-1`, `🇬🇧 London`) for automatic geographic grouping.
61
+
- Configs without a recognizable flag will be ignored.
62
+
62
63
63
64
## Getting Help
64
65
@@ -72,12 +73,8 @@ When reporting issues, include:
72
73
73
74
## Privacy & Legal
74
75
75
-
Marz is a closed-source product. Pre-built APKs are available for download. Use of the app constitutes acceptance of the terms and privacy policy (see [NOTICE.md](NOTICE.md)). For legal or compliance inquiries, open an issue and the maintainers will respond with the appropriate channels.
76
+
Use of the app constitutes acceptance of the terms and privacy policy (see [NOTICE.md](NOTICE.md)). For legal or compliance inquiries, open an issue and the maintainers will respond with the appropriate channels.
76
77
77
78
## Acknowledgements
78
79
79
-
Marz relies on several open-source networking libraries and community contributions. See project documents for formal notices and licensing information:
80
-
81
-
-[NOTICE.md](NOTICE.md)
82
-
-[LICENSE](LICENSE)
83
-
80
+
See [NOTICE.md](NOTICE.md) and [LICENSE](LICENSE) for open-source notices and licensing details.
0 commit comments