From 5f5a8fdcf6ea5898da40bfb898ffd9494f755210 Mon Sep 17 00:00:00 2001
From: defanor <defanor@uberspace.net>
Date: Sun, 19 Jul 2020 13:43:12 +0300
Subject: Document a few functions and the weechat plugin

---
 examples/weechat.c | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

(limited to 'examples')

diff --git a/examples/weechat.c b/examples/weechat.c
index ce2ffef..ac0de7d 100644
--- a/examples/weechat.c
+++ b/examples/weechat.c
@@ -1,5 +1,26 @@
-/* This is quite messy and should be refactored, but good enough for
-   testing. */
+/*
+   This is quite messy and should be refactored, but good enough for
+   testing.
+
+   Building:
+
+   gcc -fPIC -Wall -c `pkg-config --cflags --libs weechat libgsasl libxml-2.0 gnutls rexmpp` examples/weechat.c
+   gcc `pkg-config --cflags --libs weechat libgsasl libxml-2.0 gnutls rexmpp` -shared -fPIC -o weechat.so weechat.o
+   mv weechat.so ~/.weechat/plugins/rexmpp.so
+
+   Usage:
+
+   Connect: /xmpp <jid> <password>
+   Open a chat buffer (from the server buffer): q <jid>
+   Join a conference (from the server buffer): j <room>@<server>/<nick>
+
+   TODO:
+
+   - Refine/rethink control/commands.
+   - Add settings (SASL parameters and regular rexmpp configuration).
+   - Add commands for roster management and other functionality.
+   - Refactor the hacky bits of this plugin.
+*/
 
 #include <stdlib.h>
 #include <string.h>
-- 
cgit v1.2.3