Skip to content

💎 Showcase: [Refinement] README structure and quickstart #601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
google-labs-jules wants to merge 1 commit into
base: main
Choose a base branch
from
Open

💎 Showcase: [Refinement] README structure and quickstart #601

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<br/>

[![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)

</div>

> **The "Front Door" for your guild's Mythic+ groups.**
Expand All @@ -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**
Expand Down
Loading