about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2025-04-19 06:36:34 -0500
committergennyble <gen@nyble.dev>2025-04-19 06:36:34 -0500
commit0fbebbe9af03f6880b3c0d585b757f7809aa27e7 (patch)
tree0e446b6a9b9c7516ef1893a2fe5d18fa1511941e /README.md
downloadleaberblord-0fbebbe9af03f6880b3c0d585b757f7809aa27e7.tar.gz
leaberblord-0fbebbe9af03f6880b3c0d585b757f7809aa27e7.zip
works
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3707ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+EMBOARD is end-of-life and I have a need for a leaderboard bot.
+How hard could it be?
+
+Requirements:
+we want to match EMBOARDs interface. here are the commands it supports:
+- `leaderboard`
+	Displays the top 10 members in the leaderboard. 
+- `clearpoints [user]`
+	Clears the points from a user
+- `addpoints [points] [user]`
+	Add [points] to [users] (could be multiple, just mention them in [users] argument).
+- `removepoints [points] [user]`
+	ove [points] to [users] (could be multiple, just mention them in [users] argument).
\ No newline at end of file