--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Nov 06 00:43:15 2009 +0200
@@ -0,0 +1,58 @@
+
+This is a module, implementing avatar publishing/retrieving via pep/pubsub.
+This module informs you, when your buddies publish their avatars via pep
+and provides command '/avatar' to publish your own. But this is not all.
+It also will show you buddy's avatar! Yes, it is aalib :)
+
+This module depends on module 'pep'. You must load it prior to this module
+and not unload until you unload this module.
+
+For this module to actually do something you should set option
+avatars_directory - a place, where your buddy's avatars will be saved.
+
+Note, that currently only pubsub-publishing of avatars is supported
+(retrieving too works only for pubsub, but there you will be at least
+informed of url, that you can use to view avatar manually). Thus, as
+standard states, that pubsub-published data must be image/png, your
+avatar should be in png format.
+
+INSTALLATION
+
+To install it, you need:
+loudmouth
+glib
+aalib
+libpng
+mcabber's headers
+cmake
+make
+gcc
+
+Then do
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make edit_cache
+$ make
+# make install
+
+Debian users can instead of make install do
+$ fakeroot make package
+# dpkg -i ...-*.deb
+
+Users of other distributions can select appropriate package
+generator, using cache editor.
+
+LICENSE
+
+This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
+from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
+
+CONTACTS
+
+I will be happy to get feedback, patches, suggestions, etc.
+You can send me email or contact via jabber <isbear@jabber.kiev.ua>.
+
+  -- Myhailo Danylenko <isbear@ukrpost.net>
+
+