diff --git a/README.markdown b/README.markdown index 677f108..fc82d43 100644 --- a/README.markdown +++ b/README.markdown @@ -1,4 +1,5 @@ -# libstrophe +libstrophe +========== libstrophe is a lightweight XMPP client library written in C. It has minimal dependencies and is configurable for various environments. It @@ -10,7 +11,8 @@ Its goals are: - well documented - reliable -## Build Instructions +Build Instructions +------------------ If you are building from a source control checkout, run: @@ -23,9 +25,7 @@ From the top-level directory, run the following commands: ./configure make -This will create a static library, also in the top-level -directory, which can be linked into other programs. The -public API is defined in `strophe.h` which is also in the +The public API is defined in `strophe.h` which is in the top-level directory. The `examples` directory contains some examples of how to @@ -41,26 +41,27 @@ another path use the `--prefix` option during configure, e.g.: ./configure --prefix=/usr -## Requirements +Requirements +------------ libstrophe requires: - expat or libxml2 - expat is the default; use --with-libxml2 to switch -- libresolv on UNIX systems - make sure you include -lresolv - if you are compiling by hand. +- openssl on UNIX systems - libtool In addition, if you wish to run the unit tests, you will need the check package. -### OS X (with Homebrew package manager) +Installation +------------ -You can install libstrophe with: +libstrophe package has been added to popular Linux distributions, +BSD systems and OSX package managers. - brew install libstrophe - -## Documentation +Documentation +------------- API documentation is inline with the code and conforms to Doxygen standards. You can generate an HTML version of the API documentation