Skip to content

Commit e33321c

Browse files
authored
Update README.md
1 parent fef528b commit e33321c

File tree

1 file changed

+17
-20
lines changed

1 file changed

+17
-20
lines changed

README.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,31 @@
33
<h1>Marz - An <a href="https://github.com/xtls/xray-core">Xray</a>-based VPN client</h1>
44
</div>
55

6-
6+
<p align='center'>
77
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.
8+
</p>
89

910

1011
## Key Features
1112

1213
<img src="./assets/screenshot.png" width="230px" align="right" />
1314

14-
- **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
2223

2324

2425
### Who Marz Is For
2526

2627

2728
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.
2829

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.
3131

3232

3333
### Platform Availability
@@ -40,7 +40,7 @@ iOS and macOS builds are planned after the Android release reaches a stable mile
4040

4141
## Deep Linking Guide
4242

43-
Marz supports deep linking to enable one-tap subscription imports from provider websites.
43+
One-tap subscription import from provider websites:
4444

4545
### URL Scheme
4646

@@ -57,8 +57,9 @@ marz://import?url=https%3A%2F%2Fexample.com%2Fsub%2Fid&name=ProviderName
5757

5858
### Integration Tips
5959

60-
- 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+
6263

6364
## Getting Help
6465

@@ -72,12 +73,8 @@ When reporting issues, include:
7273

7374
## Privacy & Legal
7475

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.
7677

7778
## Acknowledgements
7879

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

Comments
 (0)