From 936da05029d278a5f9b819778fa30b9077002060 Mon Sep 17 00:00:00 2001
From: Ilya Grigorik <ilya@igvita.com>
Date: Sat, 5 Nov 2011 23:07:28 -0400
Subject: [PATCH] add readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b1b4131
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Hydra: load-balanced (multi-headed) SOCKS5 proxy
+
+Given a list of hosts hydra opens a pool of SOCKS5 tunnels and routes incoming requests via a random tunnel. In effect, hydra is a regular SOCKS5 proxy, except that each outbound request is automatically load-balanced.
+
+[img]
+
+Hydra uses SSH to establish the SOCKS5 tunnels and [em-proxy](https://github.com/igrigorik/em-proxy) to provide the transparent routing for any SOCKS5 compatible client.
+
+## Getting started
+
+```
+$> gem install hydra
+$> hydra --listen 8080 --hosts host1,host2 --key ssh_key.pub --verbose
+```
+
+```ruby
+c = Curl::Easy.new('http://whatismyip.org')
+c.proxy_url = 'localhost:8080'
+c.proxy_type = Curl::CURLPROXY_SOCKS5
+c.perform
+c.body_str
+
+```
+
+## License
+
+The MIT License - Copyright (c) 2011 Ilya Grigorik
\ No newline at end of file