diff --git a/README.md b/README.md index de4f94c..b82ddb6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # youtube-url-corrector -A Python bot to redirect YouTube links to Piped. +A Python based Discord bot to redirect YouTube links to Piped. + +Example `compose.yml` +```compose +version: '3' + +services: + bot: + image: git.beans.team/em/yuc:latest + environment: + - DISCORD_TOKEN=your_discord_bot_token + - PIPED_URL=https://your.piped.url/watch?v= + restart: unless-stopped +```