From d26dec7c192f03c0d55155f35d1eae32444f8c25 Mon Sep 17 00:00:00 2001 From: Bene Date: Fri, 17 May 2024 23:53:09 +0200 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 44c694b..2d42a04 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ # join2create -A simple Discord Bot to provide JoinToCreate functionality. -Create your Application and give the bot sufficient permissions (i gave id Admin). +Join2Create is a Discord bot designed to facilitate JoinToCreate functionality seamlessly within your Discord channels. -Put your Bot Key and your Channel ID in the docker-compose.yml or use this command -```docker run -d \ - --name discord-bot \ - -e BOT_TOKEN=YOUR_BOT_TOKEN_HERE \ - -e JOINTOCREATE_CHANNEL_ID=YOUR_JOINTOCREATE_CHANNEL_ID_HERE \ - git.degnedict.de/bene/join2create:latest``` \ No newline at end of file +## Getting Started + +1. **Create a Discord Application**: Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application. Make sure to grant the application sufficient permissions, preferably Administrator. + +2. **Invite the Bot to Your Server**: After creating the application, invite the bot to your Discord server using the OAuth2 URL provided in the Discord Developer Portal. + +3. **Configure Bot Parameters**: + - Open `docker-compose.yml` and input your bot token and channel ID. + - Alternatively, you can use the following Docker command: + + ```bash + docker run -d \ + --name discord-bot \ + -e BOT_TOKEN=YOUR_BOT_TOKEN_HERE \ + -e JOINTOCREATE_CHANNEL_ID=YOUR_JOINTOCREATE_CHANNEL_ID_HERE \ + git.degnedict.de/bene/join2create:latest + ``` + + Or use the one-liner version: + + ```bash + docker run -d --name discord-bot -e BOT_TOKEN=YOUR_BOT_TOKEN_HERE -e JOINTOCREATE_CHANNEL_ID=YOUR_JOINTOCREATE_CHANNEL_ID_HERE your-gitea-hub-username/discord-bot:latest + ```