Updated Home (markdown)

2014-06-14 22:53:06 -07:00 · 2014-06-14 22:53:06 -07:00 · 01598e4d11
commit 01598e4d11
parent c3f9538d24
1 changed files with 44 additions and 11 deletions
--- a/Home.md
+++ b/Home.md
@ -1,11 +1,44 @@
- [Ports and clients](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients)
- [Configure Shadowsocks with Supervisor](https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor)
- [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)
- [Optimizing](https://github.com/clowwindy/shadowsocks/wiki/Optimizing-Shadowsocks)
- [Salsa20](https://github.com/clowwindy/shadowsocks/wiki/Salsa20)
- [TCP Fast Open](https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open)
- [中文手册](https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)
- [Troubleshooting](https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting)
- [Mailing list](http://groups.google.com/group/shadowsocks)
+### About This Project
+
+Shadowsocks is a fast tunnel proxy that help you get through firewalls.
+
+### Quick Navigation
+
+- Readme
+    * [Readme]
+    * [中文手册][Chinese Readme]
+- [List of Ports and clients](https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients)
+- Advanced Usage
+    * [Configure Shadowsocks with Supervisor](https://github.com/clowwindy/shadowsocks/wiki/Configure-Shadowsocks-with-Supervisor)
+    * [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)
+- [Optimizing Shadowsocks](https://github.com/clowwindy/shadowsocks/wiki/Optimizing-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.
+
+- [Issue Tracker]
+- [Mailing list]
+- [Troubleshooting]
+
+
+[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
+[Readme]:           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