From bcb563b81370a93cb1bdbbb05b98795179b9fe6c Mon Sep 17 00:00:00 2001 From: Stefan <130162586+lilstiffy@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:05:30 +0100 Subject: [PATCH] Create README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c6aabc --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ + +## Getting Started + +1. **Clone this repository:** + + ```bash + git clone https://github.com/lilstiffy/StiffyBot.git + ``` + +2. **Install the required dependencies:** + + ```bash + pip install -r requirements.txt + ``` + +3. **Set up your Discord bot token:** + + - Create a new Discord bot on the [Discord Developer Portal](https://discord.com/developers/applications). + - Copy the token and add it to a file named `.env` in the project root: + + ```env + DISCORD_TOKEN=your-bot-token + OPEN_AI_TOKEN=your-open-ai-token + ``` + +4. **Run the bot:** + + ```bash + python bot.py + ``` + + Your bot should now be online and ready to respond to commands in your Discord server! + +## Contributing + +If you'd like to contribute to this project, feel free to do so! + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.