xuemingqiang/ShadowsocksX-NG
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #468 from timothyqiu/readme

Browse Source 
Fixes typos and styling in README
This commit is contained in:
Qiu Yuzhou
2017-08-28 10:22:44 +08:00
committed by GitHub
parent 79c575d2eb fb97b7b91f
commit 784292ca57
1 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -9,23 +9,23 @@ Next Generation of [ShadowsocksX](https://github.com/shadowsocks/shadowsocks-iOS
## Why? ## Why?
It's hard to maintain the original implementation as there is too much unused code in it. It's hard to maintain the original implementation as there is too much unused code in it.
It also embeds the ss-local source. It's crazy to maintain dependencies of ss-local. It also embeds the `ss-local` source. It's crazy to maintain dependencies of `ss-local`.
So it's hard to update the ss-local version. So it's hard to update the `ss-local` version.
Now I just copied the ss-local from homebrew. Run ss-local executable as a Launch Agent in the background. Now I just copied the `ss-local` from Homebrew. Run `ss-local` executable as a Launch Agent in the background.
Serve PAC js file as a file URL. So there is only some source code related to GUI left. Serve PAC JS file as a file URL. So there is only some source code related to GUI left.
Then I will rewrite the GUI code in Swift. Then I will rewrite the GUI code in Swift.
## Requirements ## Requirements
### Running ### Running
- Mac OS X 10.11 + - macOS 10.11+
### Building ### Building
- XCode 8.3+ - Xcode 8.3+
- cocoapod 1.2+ - CocoaPods 1.2+
## Download ## Download
@ -33,8 +33,8 @@ From [here](https://github.com/shadowsocks/ShadowsocksX-NG/releases/)
## Features ## Features
- Use ss-local from shadowsocks-libev 3.0.5 - Use `ss-local` from shadowsocks-libev 3.0.5
- Could Update PAC by download GFW List from GitHub. - Could update PAC by download GFW List from GitHub.
- Show QRCode for current server profile. - Show QRCode for current server profile.
- Scan QRCode from screen. - Scan QRCode from screen.
- Auto launch at login. - Auto launch at login.
@ -44,28 +44,28 @@ From [here](https://github.com/shadowsocks/ShadowsocksX-NG/releases/)
- Over [kcptun](https://github.com/xtaci/kcptun). Version 20170322 - Over [kcptun](https://github.com/xtaci/kcptun). Version 20170322
- Export/Import configure file. - Export/Import configure file.
- An advanced preferences panel to configure: - An advanced preferences panel to configure:
- Local socks5 listen address. - Local SOCKS5 listen address.
- Local socks5 listen port. - Local SOCKS5 listen port.
- Local socks5 timeout. - Local SOCKS5 timeout.
- If enable UDP relay. - If enable UDP relay.
- GFW List URL. - GFW List URL.
- Manual specify network service profiles which would be configure the proxy. - Manual specify network service profiles which would be configure the proxy.
- Could reorder shadowsocks profiles by drag & drop in servers preferences panel. - Could reorder shadowsocks profiles by drag & drop in servers preferences panel.
- Configurable global shortcuts for toggle running and switch proxy mode. - Configurable global shortcuts for toggle running and switch proxy mode.
## Different from orignal ShadowsocksX ## Different from original ShadowsocksX
Run ss-local as a background service through launchd, not as an in-app process. Run `ss-local` as a background service through launchd, not as an in-app process.
So after you quit the app, the ss-local maybe be still running. So after you quit the app, the `ss-local` maybe be still running.
Added a manual mode which won't configure the system proxy settings. Added a manual mode which won't configure the system proxy settings.
Then you could configure your apps to use the socks5 proxy manually. Then you could configure your apps to use the SOCKS5 proxy manually.
## Contributing ## Contributing
[![gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ShadowsocksX-NG/Lobby) [![gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ShadowsocksX-NG/Lobby)
Contributions must be available on a separately named branch based on the latest version of the main branch develop. Contributions must be available on a separately named branch based on the latest version of the main branch `develop`.
ref: [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/) ref: [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/)