Merge branch 'develop'

Add README.

README.md

@@ -0,0 +1,57 @@
+# shadowsocks-go #
+
+shadowsocks-go is a lightweight tunnel proxy which can help you get through firewalls. It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks).
+
+The protocol is compatible with the origin shadowsocks (if both have been upgraded to the latest version).
+
+# Install #
+
+Pre-compiled binaries will be provided in the future. Currently, you can install from source (assume you have go installed):
+
+On server, run
+
+```
+go get github.com/shadowsocks/shadowsocks-go/cmd/shadowsocks-server
+```
+
+On client, run
+
+```
+go get github.com/shadowsocks/shadowsocks-go/cmd/shadowsocks-local
+```
+
+# Usage #
+
+Both the server and client program will look for `config.json` in the current directory. You can use `-c` option to specify another configuration file.
+
+The configuration syntax is the same with [shadowsocks-nodejs](https://github.com/clowwindy/shadowsocks-nodejs/). You can download the sample [`config.json`](https://github.com/shadowsocks/shadowsocks-go/blob/master/config.json), change the following values:
+
+```
+server          your server ip or hostname
+server_port     server port
+local_port      local socks5 proxy port
+password        a password used to encrypt transfer
+timeout         in seconds, used by server
+port_password   specify multiple ports and passwords to support multiple users, used by server
+```
+
+Given `port_password` option, server program will ignore `server_port` and `password` options.
+
+Run `shadowsocks-server` on your server. To run it in the background, run `nohup shadowsocks-server > log &`.
+
+On client, run `shadowsocks-local`. Change proxy settings of your browser to
+
+```
+SOCKS5 127.0.0.1:local_port
+```
+
+# Command line options #
+
+Command line options can override settings from configuration files.
+
+```
+shadowsocks-local -s server_name -p server_port -l local_port -k password
+shadowsocks-server -p server_port -k password -t timeout
+```
+
+Use `-d` option to enable debug message.