aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'bot/Reminder/README.txt')
-rw-r--r--bot/Reminder/README.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/bot/Reminder/README.txt b/bot/Reminder/README.txt
new file mode 100644
index 0000000..7cd1273
--- /dev/null
+++ b/bot/Reminder/README.txt
@@ -0,0 +1,10 @@
+This plugin act this way:
+ 0. Set last_reminder_time to something long time ago.
+ 1. Sleep for some time.
+ 2. Fetch from given url.
+ 3. Parse JSON, assign result to ping_data. Expect ping_data to be dictionary.
+ 4. If the ping_data is empty go to 1.
+ 5. If last_reminder_time >= ping_data['remind_time'] go to 1.
+ 6. Make sure ping_data['users'] is an array
+ 7. Ping all nicks in ping_data['users']
+ 8. Go to 1.