Updated Home (markdown)

clowwindy 2014-09-13 01:01:00 -07:00
parent 10bb07f682
commit ac36c53481

108
Home.md

@ -1,54 +1,56 @@
### About This Project
Shadowsocks is a fast tunnel proxy that helps you bypass firewalls.
### Quick Navigation
- Getting Started
* [Tutorial]
* [中文教程][Chinese Readme]
- If you use Linode
* [Tutorial with Linode](https://github.com/clowwindy/shadowsocks/wiki/Setting-Up-Shadowsocks-on-Linode)
* [Linode 上的搭建教程](https://github.com/clowwindy/shadowsocks/wiki/%E5%9C%A8-Linode-%E4%B8%8A%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA-Shadowsocks)
- [Ports and clients](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients)
* [Windows](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows)
* [OS X](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x)
* [iOS](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios)
* [Android](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android)
* [OpenWRT](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt)
- [Optimizing Shadowsocks](https://github.com/clowwindy/shadowsocks/wiki/Optimizing-Shadowsocks)
- Advanced Usage
* [Run Shadowsocks in the Background](https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor) [(中文版:后台运行 Shadowsocks](https://github.com/clowwindy/shadowsocks/wiki/%E7%94%A8-Supervisor-%E8%BF%90%E8%A1%8C-Shadowsocks)
* [Convert Shadowsocks into an HTTP proxy](https://github.com/clowwindy/shadowsocks/wiki/Convert-Shadowsocks-into-an-HTTP-proxy)
* [Using Shadowsocks with Command Line Tools](https://github.com/clowwindy/shadowsocks/wiki/Using-Shadowsocks-with-Command-Line-Tools)
* [Setup a Shadowsocks Relay](https://github.com/clowwindy/shadowsocks/wiki/Setup-a-Shadowsocks-relay)
* Using [Salsa20](https://github.com/clowwindy/shadowsocks/wiki/Salsa20) Encryption
* [TCP Fast Open](https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open)
* [Forcing Chrome to Use Socks5 Proxy](https://github.com/clowwindy/shadowsocks/wiki/Forcing-Chrome-to-Use-Socks5-Proxy)
* [OpenVPN over Shadowsocks](https://github.com/clowwindy/shadowsocks/wiki/Connect-to-OpenVPN-over-Shadowsocks)
### Latest Release
- [Python Package Index](https://pypi.python.org/pypi/shadowsocks)
### Questions
Make sure to read [Contribute to Shadowsocks](https://github.com/clowwindy/shadowsocks/blob/master/CONTRIBUTING.md) first before you submit issues or ask questions.
- [Troubleshooting]
- [Mailing list]
- [Issue Tracker]
[Build Status]: https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat
[Chinese Readme]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open
[Mailing list]: http://groups.google.com/group/shadowsocks
[PyPI]: https://pypi.python.org/pypi/shadowsocks
[PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
[Tutorial]: https://github.com/clowwindy/shadowsocks/blob/master/README.md
[Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
[TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
[Travis CI]: https://travis-ci.org/clowwindy/shadowsocks
[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
### About This Project
Shadowsocks is a fast tunnel proxy that helps you bypass firewalls.
### Quick Navigation
- Getting Started
* [Tutorial]
* [中文教程][Chinese Readme]
- If you use Linode
* [Tutorial with Linode](https://github.com/clowwindy/shadowsocks/wiki/Setting-Up-Shadowsocks-on-Linode)
* [Linode 上的搭建教程](https://github.com/clowwindy/shadowsocks/wiki/%E5%9C%A8-Linode-%E4%B8%8A%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA-Shadowsocks)
- [Ports and clients](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients)
* [Windows](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#windows)
* [OS X](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x)
* [iOS](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios)
* [Android](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android)
* [OpenWRT](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt)
- [Optimizing Shadowsocks](https://github.com/clowwindy/shadowsocks/wiki/Optimizing-Shadowsocks)
- Advanced Usage
* [Run Shadowsocks in the Background](https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor) [(中文版:后台运行 Shadowsocks](https://github.com/clowwindy/shadowsocks/wiki/%E7%94%A8-Supervisor-%E8%BF%90%E8%A1%8C-Shadowsocks)
* [Convert Shadowsocks into an HTTP proxy](https://github.com/clowwindy/shadowsocks/wiki/Convert-Shadowsocks-into-an-HTTP-proxy)
* [Using Shadowsocks with Command Line Tools](https://github.com/clowwindy/shadowsocks/wiki/Using-Shadowsocks-with-Command-Line-Tools)
* [Setup a Shadowsocks Relay](https://github.com/clowwindy/shadowsocks/wiki/Setup-a-Shadowsocks-relay)
* Using [Salsa20](https://github.com/clowwindy/shadowsocks/wiki/Salsa20) Encryption
* [TCP Fast Open](https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open)
* [Forcing Chrome to Use Socks5 Proxy](https://github.com/clowwindy/shadowsocks/wiki/Forcing-Chrome-to-Use-Socks5-Proxy)
* [OpenVPN over Shadowsocks](https://github.com/clowwindy/shadowsocks/wiki/Connect-to-OpenVPN-over-Shadowsocks)
* [Using Workers](https://github.com/clowwindy/shadowsocks/wiki/Workers)
* [Graceful shutdown and restart](https://github.com/clowwindy/shadowsocks/wiki/Graceful-shutdown-and-restart)
### Latest Release
- [Python Package Index](https://pypi.python.org/pypi/shadowsocks)
### Questions
Make sure to read [Contribute to Shadowsocks](https://github.com/clowwindy/shadowsocks/blob/master/CONTRIBUTING.md) first before you submit issues or ask questions.
- [Troubleshooting]
- [Mailing list]
- [Issue Tracker]
[Build Status]: https://img.shields.io/travis/clowwindy/shadowsocks/master.svg?style=flat
[Chinese Readme]: https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
[Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open
[Mailing list]: http://groups.google.com/group/shadowsocks
[PyPI]: https://pypi.python.org/pypi/shadowsocks
[PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
[Tutorial]: https://github.com/clowwindy/shadowsocks/blob/master/README.md
[Supervisor]: https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor
[TCP_FASTOPEN]: https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
[Travis CI]: https://travis-ci.org/clowwindy/shadowsocks
[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
[SwitchySharp]: https://chrome.google.com/webstore/detail/proxy-switchysharp/dpplabbmogkhghncfbfdeeokoefdjegm