docs/readme.mdwn
changeset 56 f0e3c123d506
parent 11 18de00544c46
child 58 694833145b98
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/readme.mdwn	Mon Aug 20 22:49:24 2012 +0300
@@ -0,0 +1,59 @@
+
+# Service Discovery
+
+This is a module for mcabber to send service discovery requests.
+
+It provides mcabber command 'disco'. To use this module just load it -
+then command will be available.
+
+With this you can discover abilities of various jabber entities, like
+servers, transports etc. Note, that it can only provide information,
+what to do with this information (eg register to entity, that supports
+it) is not this module's task. Note also, that if you want to get
+abilities of some buddy, you should send disco request to specific
+resource of that buddy (because of this this command supports extended
+notation ./resource), if you'll send request to bare jid, you'll get
+reply from server, that serves that jid.
+
+# Installation
+
+To install it, you need:
+
+ * mcabber headers
+ * glib
+ * loudmouth
+ * cmake
+ * make
+ * c compiler (gcc)
+ * linker (binutils)
+
+Then do:
+
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ make edit_cache
+    $ make
+    # make install
+
+Debian users can instead of make install do:
+
+    $ make package
+    # dpkg -i libmcabber-disco_*.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/>.
+
+# Contact
+
+I will be happy to get feedback, patches, suggestions, etc.
+You can send me email or contact via jabber <isbear@unixzone.org.ua>.
+
+  -- Myhailo Danylenko <isbear@ukrpost.net>
+