From a1bb86036c3a68731439de20cfe2a500332a8b2c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20S=C5=82omkowski?= <m.slomkowski@gmail.com>
Date: Sat, 7 Nov 2015 19:21:48 +0100
Subject: [PATCH] Add README.

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 45 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 195f11b..efae754 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,45 @@
-# mumlib
-Simple Mumble library using boost::asio, non-functional, still in development.
+# mumlib - simple Mumble client library
+
+Fairy simple Mumble library written in C++, using *boost::asio* asynchronous networking framework. Library supports:
+
+* audio streaming through TCP and UDP channel
+* text messaging
+
+Todo:
+
+* channel support
+* user information
+* remaining server messages (ACL, user stats etc)
+
+## Dependencies
+
+* Boost libraries
+* OpenSSL
+* *log4cpp*
+* Opus library
+* Google Protobuf: libraries and compiler
+* CMake
+
+## Build
+
+The library uses CMake build system:
+
+```
+mkdir build && cd build
+cmake ..
+make
+```
+
+## Usage
+
+Sample usage is covered in *mumlib_example.cpp* file. Basically, you should extend *mumlib::Callback* class
+to implement your own handlers.
+
+## Credits
+
+2015 Michał Słomkowski. The code is published under the terms of Lesser General Public License Version 3.
+
+The library contains code from following 3rd party projects:
+
+* official Mumble Client: https://github.com/mumble-voip/mumble
+* *libmumble*: https://github.com/cornejo/libmumble
\ No newline at end of file