From 26ad0f78dd24ac71666d9258eed5596055459277 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Er=C3=A8be=20-=20Romain=20Gerard?= <github@erebe.eu>
Date: Wed, 15 Jun 2016 11:23:52 +0200
Subject: [PATCH 1/3] Update README.md

---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 4020d55..6aed6e7 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 # wstunnel
 
 ## TODO
-- Add sock5 proxy
-- Add better logging
-- Add better error handling
-- Add httpProxy authentification
-- Add Reverse tunnel
+- [] Add sock5 proxy
+- [x] Add better logging
+- [x] Add better error handling
+- [x] Add httpProxy authentification
+- [] Add Reverse tunnel

From c09f2953a24be2539fda1d0ca69c277ff678f835 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Er=C3=A8be=20-=20Romain=20Gerard?= <github@erebe.eu>
Date: Wed, 15 Jun 2016 11:24:51 +0200
Subject: [PATCH 2/3] Update README.md

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6aed6e7..f7467c6 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 # wstunnel
 
 ## TODO
-- [] Add sock5 proxy
+- [ ] Add sock5 proxy
 - [x] Add better logging
 - [x] Add better error handling
 - [x] Add httpProxy authentification
-- [] Add Reverse tunnel
+- [ ] Add Reverse tunnel

From c49c162b4aafcd954bd9081ccbe1a0369c7e49ad Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Er=C3=A8be=20-=20Romain=20Gerard?= <github@erebe.eu>
Date: Tue, 21 Jun 2016 22:16:19 +0200
Subject: [PATCH 3/3] Update README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index f7467c6..e0c2dc6 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,29 @@
 # wstunnel
+```
+
+Use the websockets protocol to tunnel {TCP,UDP} traffic
+wsTunnelClient <---> wsTunnelServer <---> RemoteHost
+Use secure connection (wss://) to bypass proxies
+wstunnel [OPTIONS] ws[s]://wstunnelServer[:port]
+Client options:
+  -L --localToRemote=[BIND:]PORT:HOST:PORT  Listen on local and forward
+                                            traffic from remote
+  -u --udp                                  forward UDP traffic instead of
+                                            TCP
+  -p --httpProxy=USER:PASS@HOST:PORT        If set, will use this proxy to
+                                            connect to the server
+Server options:
+     --server                               Start a server that will forward
+                                            traffic for you
+  -r --restrictTo=HOST:PORT                 Accept traffic to be forwarded
+                                            only to this service
+Common options:
+  -v --verbose                              Print debug information
+  -q --quiet                                Print only errors
+  -h --help                                 Display help message
+  -V --version                              Print version information
+                                                                                
+```
 
 ## TODO
 - [ ] Add sock5 proxy