beautify README

1 files changed, 36 insertions, 16 deletions

diff --git a/README b/README
index d54f955d..ecf0d964 100644
--- a/README
+++ b/README
@@ -1,42 +1,59 @@
 ABOUT
+-----
 
-This is QXmpp version 0.1.
 QXmpp is cross-platform C++ client library for XMPP. It is based on Qt.
 
+QXmpp is released under the terms of the GNU Lesser General Public License,
+version 2.1 or later.
 
-BUILDING QXmpp
+BUILDING QXMPP
+--------------
 
 You need to have Qt 4.5 or higher to build the QXmpp.
 The project uses qmake build system of Qt.
 
-Commands to build QXmpp:
+Building from the command line:
+
 cd <where QXmppClient.pro is lying>
 qmake
 <respective-make-cmd = gmake, make, mingw32-make, nmake>
 
-Using Qt Creator:
-Open the QXmppClient.pro file in Qt Creator and hit Buil All to build all the examples and library.
+Building using Qt Creator:
+
+Open the qxmpp.pro file in Qt Creator and hit Buil All to build all
+the examples and library.
+
 
 EXAMPLES
+--------
 
-Have a look the available examples to start using this library.
+Have a look the available examples to start using this library. Logging has
+been set to stdout so you can see the progress on the command line.
 
 * example_0_connected
-This example just connects to the xmpp server. And start receiving presences (updates) from the server.
-After running this example, you can see this user online, if it's added in your roster (friends list).
-Logging type has been set to stdout. You can see the progress on the command line.
+
+This example just connects to the xmpp server and start receiving presences
+(updates) from the server. After running this example, you can see this user
+online, if it's added in your roster (friends list).
+
 
 * example_1_echoClient
-This is a very simple bot which echoes the message sent to it.
-Run this example, send it a message from a friend of this bot. You will recieve the message back.
-This example shows how to receive and send messages.
 
-REFERENCE DOCUMENTATION
+This is a very simple bot which echoes the message sent to it. Run this
+example, send it a message from a friend of this bot and you will
+receive the message back. This example shows how to receive and send messages.
+
+
+DOCUMENTATION
+-------------
+
+You can find information about QXmpp, on the project homepage:
 
 http://code.google.com/p/qxmpp
 
 
 SUPPORTED PLATFORMS
+-------------------
 
 For this release, the following platforms have been tested:
 
@@ -47,14 +64,17 @@ For this release, the following platforms have been tested:
   linux-g++-64
 
 It should work on all the plaforms supported by Qt.
-For a complete list of supported platforms, see
+For a complete list of supported platforms, see:
+
 http://www.qtsoftware.com/developer/supported-platforms/supported-platforms/
 
 
 HOW TO REPORT A BUG
+-------------------
 
 If you think you have found a bug in QXmpp, we would like to hear about
-it so that we can fix it. Before reporting a bug, please check 
+it so that we can fix it. Before reporting a bug, please check if the issue
+is already know at:
+ 
 http://code.google.com/p/qxmpp/issues/
-to see if the issue is already known.