initHEADmain

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..707e197
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# League Stat Sync Bot
+
+A simple Discord bot that helps users track their League of Legends stats and display them on their profile.
+
+## Features
+
+- **League Sync**: Users can register their League of Legends account (game name, tag, and platform) using a simple slash command.
+- **Auto-Update**: The bot periodically syncs and updates the user's data via the Discord API.
+
+![League Widget Preview](https://imgur.com/9uXTqR8)
+
+## Usage
+
+1. Invite the bot to your server.
+2. Use the `/sync` command to link your account:
+
+- **game_name**: Your League username.
+- **tag_line**: Your Riot tag (without the #).
+- **platform**: Your region (e.g., EUW1, NA1).
+
+3. The bot will automatically handle the rest!
+
+## Getting Started
+
+To run this bot, ensure you have your `.env` file configured with your `DISCORD_BOT_TOKEN`, `RIOT_API_KEY`, `DISCORD_APP_ID` and `DISCORD_IDENTITY_ID`. 
+Run the bot using:
+
+```bash
+uv run main.py
+
+```