Merge branch 'master' of github.com:hocken/wxg

README

@@ -1,22 +1,34 @@
 WebSocket XMPP Gateway (WXG) - README
 =====================================
-WXG (pronounce as "Wixig") is a Java-implementation of a gateway enabling communication with native XMPP[1] servers over the WebSocket protocol[2] and API[3], as specified in [4].
+WXG (pronounce as "Wixig") is a Java-implementation of a gateway enabling communication 
+with native XMPP[1] servers over the WebSocket protocol[2] and API[3], as specified in [4].
 
-Until now, one of the common techniques in using XMPP in JS-powered Web applications was to make use of BOSH[5] and XMPP over BOSH[6]. However, with the advent of the WebSocket protocol and API already widely available in modern Web browsers, the unstable and slow BOSH technique should be replaced. Currently, most XMPP servers are not equipped with connectors for receiving and delivering stanzas over the WebSocket protocol as specified in [4].
+Until now, one of the common techniques in using XMPP in JS-powered Web applications was 
+to make use of BOSH[5] and XMPP over BOSH[6]. However, with the advent of the WebSocket 
+protocol and API already widely available in modern Web browsers, the unstable and slow 
+BOSH technique should be replaced. Currently, most XMPP servers are not equipped with 
+connectors for receiving and delivering stanzas over the WebSocket protocol as specified in [4].
 
 The following scheme shows the basic functionality of WXG:
 
 Client	<---->	ws(xmpp) <----> WXG <----> xmpp <----> XMPP Server
 
 As such, WXG realizes two basic use cases:
-1) When a client sends an XMPP stanza encapsulated in a WebSocket message, WXG "unpacks" the stanza and forwards it to the XMPP server natively.
-2) When an XMPP server directs a stanza to one of its clients, WXG receives the native stanza, wraps it into a WebSocket message and forwards it to the client.
+
+1) When a client sends an XMPP stanza encapsulated in a WebSocket message, WXG "unpacks" the 
+stanza and forwards it to the XMPP server natively.
+
+2) When an XMPP server directs a stanza to one of its clients, WXG receives the native stanza, 
+wraps it into a WebSocket message and forwards it to the client.
 
 In the following we describe how to build, configure, and run WXG.
 
 Prerequisites
 =============
-WXG is implemented in Java. In order to build and run WXG, an installed Java SDK is required. For performing automated builds of WXG, an installation of Apache Ant (http://ant.apache.org/) is required to run the bundled build script.
+- for running WXG, an installed Java Runtime Environment is required.
+- for building WXG, an installed Java SDK is required.
+- for performing automated builds of WXG, an installation of Apache Ant (http://ant.apache.org/) 
+  is required to run the bundled build script.
 
 Check-out and build WXG
 =======================