Skip to content

Commit bfa5606

Browse files
Update README.md
1 parent f3b9a76 commit bfa5606

1 file changed

Lines changed: 64 additions & 1 deletion

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
1-
# VPN Client XRAY Wrapper (vpnclient_xray_wrapper)
1+
# πŸš€ VPN Client XRAY Wrapper ('vpnclient_xray_wrapper')
2+
3+
A high-performance VPN client wrapper for Xray-core, designed to provide secure and private internet access. This project implements VPN functionality for Android, iOS, macOS, Windows and Linux platforms.
4+
5+
## 🌟 Features
6+
- πŸ”’ Secure VPN tunneling using Xray-core
7+
- πŸ”„ Support for multiple protocols (VMess, VLESS, Trojan, etc.)
8+
- πŸ“± Cross-platform implementation (Android/iOS)
9+
- ⚑ Optimized for performance and battery efficiency
10+
- πŸ› οΈ Configurable through simple JSON configuration
11+
12+
## πŸ“‹ Requirements
13+
- πŸ€– Android 6.0+, 🍎 iOS 12.0+
14+
- βœ… Appropriate VPN permissions
15+
16+
## πŸ“₯ Installation
17+
18+
### πŸ€– Android
19+
1. πŸ“‚ Clone this repository
20+
2. πŸš€ Open the project in Android Studio
21+
3. πŸ”¨ Build and run the application
22+
23+
```bash
24+
git clone https://github.com/VPNclient/VPNclient-xray-wrapper.git
25+
cd VPNclient-xray-wrapper/android
26+
./gradlew assembleDebug
27+
```
28+
29+
### 🍎 iOS
30+
1. πŸ“‚ Clone this repository
31+
2. πŸš€ Open the project in Xcode
32+
3. πŸ”¨ Build and run the application
33+
34+
```bash
35+
git clone https://github.com/VPNclient-repo/VPNclient-xray-wrapper.git
36+
open VPNclient-xray-wrapper/ios/VPNClient.xcodeproj
37+
```
38+
39+
## βš™οΈ Configuration
40+
Create a `config.json` file with your Xray-core configuration:
41+
42+
```json
43+
{
44+
"inbounds": [...],
45+
"outbounds": [...],
46+
"routing": {...}
47+
}
48+
```
49+
50+
## πŸš€ Usage
51+
1. πŸ“ Place your Xray configuration in the app's documents directory
52+
2. ▢️ Launch the application
53+
3. πŸ“‘ Select your configuration file
54+
4. πŸ”— Tap "Connect" to establish the VPN connection
55+
56+
57+
## 🀝 Contributing
58+
We welcome contributions! Please fork the repository and submit pull requests.
59+
60+
## πŸ“œ License
61+
62+
63+
## πŸ’¬ Support
64+
For issues or questions, please open an issue on our GitHub repository.

0 commit comments

Comments
Β (0)