commit 66cf2fb162110b75679cc5cd68a3cb063b586032
parent 8030a5ee2aa2ec6c8d442f84dd6f885c379547b2
Author: ugrnm <ultrageranium@bleu255.com>
Date: Thu, 14 Nov 2024 23:34:22 +0100
readme
Diffstat:
| A | README | | | 52 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 52 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,52 @@
+warawara
+========
+
+XMPP bot for cerca public RSS feed.
+
+
+hu?
+---
+
+warawara is a simple XMPP bot that fetches an RSS feed and will only retain
+the top element (title, description and link). This data will be used to form
+a groupchat message for an XMPP MUC. Every 16 minutes it tries again and if
+there is something new it will post it, otherwise it will sleep further.
+
+It can be used for other RSS feeds but the odd choices are here because it is
+essentially made to be used with the cerca forum, which public feed only
+display the latest posts, only one per thread, most recent at the top.
+
+It's not really meant to be an accurate notification system, because it does
+not even try to parse anything beyond fetching the first XML items, so if more
+than one message is posted between two fetches, only the latest one will be
+retained. Also cerca does not keep the history of recent messages in the feed
+either, so at best warawara could just improve accuracy across threads, but not
+within one thread.
+
+It's OK, warawa is just meant to be a little reminder that there is some
+activity on the forum.
+
+
+usage
+-----
+
+warawara [options]
+
+-bot bot JID
+-muc MUC JID
+-password bot JID password
+-server server to join
+-url RSS feed URL
+
+
+example
+-------
+
+warawara -bot news@xmpp.pizza \
+ -password h4cKM3
+ -server xmpp.pizza
+ -muc partyline@muc.xmpp.pizza
+ -url https://login:password@cerca.exxonmobil.com/rss.xml
+
+
+
