Merge branch 'master' of github.com:qxmpp-project/qxmpp

1 files changed, 30 insertions, 16 deletions

diff --git a/README.md b/README.md
index d6e5e8cc..30a1cc05 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,19 @@
 ABOUT QXMPP
 ===========
 
-QXmpp is cross-platform C++ client library for XMPP. It is based on Qt.
+QXmpp is a cross-platform C++ XMPP client and server library. It is written
+in C++ and uses Qt framework.
+
+QXmpp strives to be as easy to use as possible, the underlying TCP socket,
+the core XMPP RFCs (RFC3920 and RFC3921) and XMPP extensions have been
+nicely encapsulated into classes. QXmpp comes with full API
+documentation, automatic tests and many examples.
+
+QXmpp uses Qt extensively, and as such users need to a have working knowledge
+of C++ and Qt basics (Signals and Slots and Qt data types).
+
+Qt is the only third party library which is required to build QXmpp, but
+libraries such as speex and theora enable additional features.
 
 QXmpp is released under the terms of the GNU Lesser General Public License,
 version 2.1 or later.
@@ -11,10 +23,10 @@ version 2.1 or later.
 BUILDING QXMPP
 ==============
 
-You need to have Qt 4.5 or higher (with SSL enabled) to build the QXmpp.
-The project uses qmake build system of Qt.
+QXmpp requires Qt 4.5 or higher (with SSL enabled) and it uses 
+the standard qmake build system of Qt.
 
-Building from the command line:
+Build from command line:
 
     cd <where qxmpp.pro is located>
     qmake <arguments>
@@ -36,7 +48,7 @@ Note: by default QXmpp is built as a shared library. If you decide to build
 a static library instead, you will need to pass -DQXMPP_STATIC when building
 your programs against QXmpp.
 
-Building using Qt Creator:
+Build using Qt Creator:
 
 Open the qxmpp.pro file in Qt Creator and hit "Build All" to build all
 the examples and library.
@@ -44,10 +56,11 @@ the examples and library.
 INSTALLING QXMPP
 ================
 
-After building QXmpp the you can install the Headers, Libraries 
+After building QXmpp, you can install the Headers, Libraries 
 and Documentation using the following command:
 
-Installing from the command line:
+Install from command line:
+
     <respective-make-cmd = gmake, make, mingw32-make, nmake> install
 
 Path of installations:
@@ -62,7 +75,8 @@ to your C++ flags.
 EXAMPLES
 ========
 
-Look at the example directory for various examples.
+Look at the example directory for various examples. Here is a description of 
+a few.
 
 * *example_0_connected*
 This example just connects to the xmpp server and start receiving presences
@@ -81,14 +95,19 @@ the part of this library.
 DOCUMENTATION
 =============
 
-You can find information about QXmpp, on the project homepage:
+You can find the API documentation for the latest QXmpp version here:
 
-https://github.com/qxmpp-project/qxmpp
+http://doc.qxmpp.org/qxmpp-snapshot/
 
 SUPPORTED PLATFORMS
 ===================
 
-For this release, the following platforms have been tested:
+It should work on all the plaforms supported by Qt. For a complete list of
+platforms support by Qt, see:
+
+http://qt-project.org/doc/supported-platforms.html
+
+In past, we have tested on variety of platforms:
 
     win32-g++        (Qt SDK)
     win32-msvc2008   (Qt MSVC-2008)
@@ -97,11 +116,6 @@ For this release, the following platforms have been tested:
     linux-g++        (32-bit and 64-bit)
     macos-g++        (32-bit and 64-bit)
 
-It should work on all the plaforms supported by Qt. For a complete list of
-platforms support by Qt, see:
-
-http://qt-project.org/doc/supported-platforms.html
-
 Please note that on Symbian, you will need to make sure your add the
 "NetworkServices" to your application to enable it to access the network.
 You can do this by adding the following to your .pro file: