From c35aa860820baf880e2afc62b8f704a9017aa662 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 08:26:18 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=8E=20Showcase:=20[Refinement]=20READM?= =?UTF-8?q?E=20structure=20and=20quickstart?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ✨ Visuals: Updated the header to follow the "Golden Template" structure. The Critical Link Array (badges and text links) now immediately follows the title without extraneous heading tags or line breaks, improving immediate visibility. 🔗 Links: Fixed the `Install Dependencies` and `Configure Environment` quick start commands. Changed `npm ci` to `./setup.sh` to ensure environment parity (including system dependencies) and corrected the `.env` creation path from the root directory to `packages/bot/` to ensure the bot can load it properly. ✂️ Trimmed: Removed legacy `### ` formatting on the link array for cleaner presentation. --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 36dba630..9c5b4e14 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,11 @@ # MythicPlusDiscordBot 💎 -### [ 🚀 Launch App ](https://tytaniumdev.github.io/MythicPlusDiscordBot/) | [ 📖 Documentation ](#documentation-map) | [ 🐞 Report Bug ](https://github.com/tytaniumdev/MythicPlusDiscordBot/issues/new?template=bug_report.md) - -
- [![Build Status](https://github.com/tytaniumdev/MythicPlusDiscordBot/actions/workflows/deploy.yml/badge.svg)](https://github.com/tytaniumdev/MythicPlusDiscordBot/actions) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) +[ 🚀 Launch App ](https://tytaniumdev.github.io/MythicPlusDiscordBot/) | [ 📖 Documentation ](#documentation-map) | [ 🐞 Report Bug ](https://github.com/tytaniumdev/MythicPlusDiscordBot/issues/new?template=bug_report.md) + > **The "Front Door" for your guild's Mythic+ groups.** @@ -33,14 +31,14 @@ Get up and running in less than 5 minutes. 2. **Install Dependencies** This project uses `npm` workspaces. ```bash - npm ci + ./setup.sh ``` 3. **Configure Environment** - Create a `.env` file in the `packages/bot` directory (or the root directory): + Create a `.env` file in the `packages/bot` directory: ```bash - echo "BOT_TOKEN=your_token_here" > .env - echo "DISCORD_APPLICATION_ID=your_app_id" >> .env + echo "BOT_TOKEN=your_token_here" > packages/bot/.env + echo "DISCORD_APPLICATION_ID=your_app_id" >> packages/bot/.env ``` 4. **Run the Bot**