Merge pull request #124 from Mandar-Shinde/master

Created README.md for github.com

1 files changed, 19 insertions, 6 deletions

diff --git a/README b/README.md
index 9fa6e9a..745d01f 100644
--- a/README
+++ b/README.md
@@ -1,7 +1,10 @@
+FreeRDP-WebConnect 
+======
 FreeRDP-WebConnect will be a gateway for seamless access to your RDP-Sessions
-in any HTML5-compliant browser. In particular it relies on the
-Canvas (http://www.w3.org/TR/2dcontext/) and
-WebSockets (http://www.w3.org/TR/websockets/) feature.
+in any HTML5-compliant browser. 
+In particular it relies on the features
+* Canvas (http://www.w3.org/TR/2dcontext/) 
+* WebSockets (http://www.w3.org/TR/websockets/) 
 
 The server side WebSockets implementation handles current RFC6455
 (http://tools.ietf.org/html/rfc6455) only, so browsers that implement
@@ -15,8 +18,18 @@ connect as a client to any RDP session.
 Although the project is still in a very early development phase (project was started
 on April 3, 2012), it already can display an RDP session right now. 
 
-Added automated build/install script setup-all.sh
-For unattended setup, installing all prereqs and deleting conflicting packages, run the script as root, specifying the following command:
+### Installation ###
+**Automated build/install script**::
+```sh
+setup-all.sh
+```
+**Unattended install script**
+```sh
 ./setup-all.sh -f -i -d
+```
+* Force to run as root user (-f)
+* Install all dependency packages (-i)
+* Remove conflicting packages (-d)
 
-For addition details on the setup script and webconnect prereqs consult wsgate/README.
\ No newline at end of file
+### More Details ###
+For addition details on the setup script and webconnect prereqs consult [wsgate/README](wsgate/README).