diff options
| author | alex <[email protected]> | 2026-07-12 10:19:24 +0200 |
|---|---|---|
| committer | alex <[email protected]> | 2026-07-12 10:19:24 +0200 |
| commit | b63c2933b244feebeb1c26fd31b02e5655a867e1 (patch) | |
| tree | dcd84844a0ccd0ed6c41cb94dbc02e8473c7cec0 /README.md | |
| download | league-discord-widget-b63c2933b244feebeb1c26fd31b02e5655a867e1.tar.xz league-discord-widget-b63c2933b244feebeb1c26fd31b02e5655a867e1.zip | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
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. + + + +## 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 + +``` |