Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit 8d8833b

Browse files
authored
Merge pull request #36 from specter119/master
add install method by brew-cask and modify README
2 parents ec289dd + 30ca95d commit 8d8833b

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
11
![V2RayX](https://raw.githubusercontent.com/Cenmrev/V2RayX/master/V2RayX/Assets.xcassets/AppIcon.appiconset/vx128.png)
22

33
# V2RayX: A simple GUI for V2Ray on macOS
4-
## what is V2Ray?
4+
5+
## What is V2Ray?
6+
57
![V2Ray logo](https://raw.githubusercontent.com/v2ray/manual/master/resources/favicon-152.png)
68

79
[Project V2Ray](http://www.v2ray.com).
810

911
__YOU SHOULD READ V2RAY'S OFFICIAL INSTRUCTION BEFORE USING V2RAYX!__
1012

1113
## Download V2RayX
12-
[Releases](https://github.com/Cenmrev/V2RayX/releases)
14+
15+
Download from [Releases](https://github.com/Cenmrev/V2RayX/releases), or install by [Homebrew-Cask](https://caskroom.github.io/).
16+
17+
```sh
18+
brew cask install v2rayx
19+
```
1320

1421
## How to build
22+
1523
V2RayX.app is built by running one of the following commands in your terminal. You can install this via the command-line with curl.
1624

1725
`sh -c "$(curl -fsSL https://raw.githubusercontent.com/Cenmrev/V2RayX/master/compilefromsource.sh)"`
@@ -23,26 +31,29 @@ or step by step:
2331
open V2RayX.xcodeproj and use Xcode to build V2RayX.
2432

2533
## How does V2RayX work
34+
2635
V2RayX provides a GUI to generate the config file for V2Ray. It includes V2Ray's binary executable in the app bundle. V2RayX starts and stops V2Ray with `launchd` of macOS.
2736

2837
V2RayX also allows users to change system proxy settings and switch proxy servers on the macOS menu bar.
2938

3039
As default, V2RayX will open a socks5 proxy at port `1081` as the main inbound, as well as a http proxy at port `8001` as an inboundDetour.
3140

3241
### auto-run on login
42+
3343
Open macOS System Preferences -> Users & Group -> Login Itmes, add V2RayX.app to
3444
the list.
3545

3646
### 登录后自动运行
37-
打开 macOS 系统设置 -> 用户与组 -> 登录项,把 V2RayX.app 添加到列表中。
3847

48+
打开 macOS 系统设置 -> 用户与组 -> 登录项,把 V2RayX.app 添加到列表中。
3949

4050
### manually update v2ray-core
4151
replace `V2RayX.app/Contents/Resources/v2ray` with the newest v2ray
4252
version from [v2ray-core
4353
repo](https://github.com/v2ray/v2ray-core/releases). However, compatibility is not guaranteed.
4454

4555
### Uninstall
56+
4657
V2RayX will create the following files and folders:
4758

4859
* `/Library/Application Support/V2RayX`

0 commit comments

Comments
 (0)