From 95cb8bc86881ab6aa23194093ff29e525e8d4dce Mon Sep 17 00:00:00 2001
From: Marc Di Luzio <marc.diluzio@gmail.com>
Date: Fri, 9 Aug 2024 23:33:39 +0100
Subject: [PATCH] Update the README with useful info

---
 README.md | 25 ++++++++++++++++++++++---
 matchy.py |  1 -
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index b952f4d..255c780 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,32 @@
 # Matchy
-Matchy matches matchees
+Matchy matches matchees.
+
+Matchy is a Discord bot that groups up users for fun and vibes. Matchy can be installed by clicking [here](https://discord.com/oauth2/authorize?client_id=1270849346987884696).
 
 ## Commands
 ### /match
+Matches groups of users with a given role and posts those groups to the channel.
+
+### $sync
+Only usable by `OWNER` users, reloads the config and syncs commands. Only usable in DMs with the bot user. 
 
 ## Dependencies
 * `python3` obviously
 * `discord.py` python module
 * `pytest` for testing
 
-## Token
-Create a `config.py` file with a `TOKEN=<token>` entry
+## Config
+Matchy is configured by a `config.py` file that takes this format:
+```
+TOKEN = "<<TOKEN>>"
+OWNERS = [
+    <<USER ID>>,
+]
+```
+User IDs can be grabbed by turning on Discord's developer mode and right clicking on a user.
+
+## TODO
+* Write bot tests with [dpytest](https://dpytest.readthedocs.io/en/latest/tutorials/getting_started.html)
+* Add tracking of past groups to ensure unique pairings
+* Add scheduling functionality
+* Improve the weirdo
\ No newline at end of file
diff --git a/matchy.py b/matchy.py
index ce01482..da6a58a 100755
--- a/matchy.py
+++ b/matchy.py
@@ -9,7 +9,6 @@ from discord import app_commands
 from discord.ext import commands
 # Config contains
 # TOKEN : str - Discord bot token
-# SERVERS : list[int] - ids of the servers to have commands active
 # OWNERS : list[int] - ids of owners able to use the owner commands
 import config