about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2025-08-04 13:33:52 -0500
committergennyble <gen@nyble.dev>2025-08-04 13:33:52 -0500
commit4763e1b50a082bcf498a897d7b41c6e41466e31c (patch)
tree9ee254199ed9f206c4b478ba6fea089de2fb7a27 /README.md
parent76c1f83074e84a21eb5f5a69b160b1facbeb9cac (diff)
downloadleaberblord-4763e1b50a082bcf498a897d7b41c6e41466e31c.tar.gz
leaberblord-4763e1b50a082bcf498a897d7b41c6e41466e31c.zip
Add style explanation to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 22 insertions, 3 deletions
diff --git a/README.md b/README.md
index d33bf21..7925c7f 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,28 @@ Uh oh, the code is kinda bad.
 
 [Invite Link](https://discord.com/oauth2/authorize?client_id=1363055126264283136&permissions=2048&integration_type=0&scope=bot+applications.commands)
 
-Requirements- We want to do what emboard can at least. here is what we do so far.  
+**Commands**  
 - `about`: Get information about the bot.  
-- `leaderboard`: Displays the leaderboard.  
+- `leaderboard`: Displays the leaderboard. With an optional `[style]` argument to change how it displays.  
 - `points [points] [user]`: Change the points of the mentioned users  
 - `permission none`: No permissions are required to change the score; anyone may set the score. This command requires the Manage Server permission.  
-- `permission role [role]`: A specific role is required to change the score. This command requires the Manage Server permission.  
\ No newline at end of file
+- `permission role [role]`: A specific role is required to change the score. This command requires the Manage Server permission.  
+
+**Leaderboard Display Options**  
+The leaderboard display options, the `style` argument of the leaderboard command, change how ties are displayed. Ties will always be ordered by who was there sooner.
+
+`Ties Equal` puts ties in the same placement. It will look like this:  
+```
+1. genny: 10
+2. medley: 5
+   inann: 5
+4. taiga: 3
+```
+
+`Ties Broken` puts ties in different placements. It will look like this:  
+```
+1. genny: 10
+2. medley: 5
+3. inann: 5
+4. taiga: 3
+```