From 8b19393d7cf4422abcb5a6816884ed8cf1259223 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tr=C3=A8sAbhi?= <43380238+tresabhi@users.noreply.github.com> Date: Sun, 1 Oct 2023 17:36:03 -0500 Subject: [PATCH] feat: updated README to be better lol --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d8f52d033..6c7ae732f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,42 @@ # blitzkrieg -A Discord bot for anything and everything related to World of Tanks Blitz. +Tools for everything World of Tanks Blitz -## Invite the Bot +## Invite the bot -Join the [Discord server](https://discord.gg/nDt7AjGJQH), click on the bot's profile, and click "Add to Server". +Go to [application directory for Blitzkrieg](https://discord.com/application-directory/1097673957865443370) and click "Add to Server." Voila! You're ready to go. -## Using +![Blitzkrieg application directory](https://i.imgur.com/JlEA0J1.png) -### Installing dependencies +## Visit the website + +### https://blitz-krieg.vercel.app/ + +![Blitzkrieg website](https://i.imgur.com/QOXUP63.png) + +## Visit the documentation website + +### https://tresabhi.github.io/blitzkrieg/ + +![Blitzkrieg documentation website](https://i.imgur.com/mCZCZEI.png) + +## Run the bot + +### Install dependencies ```bash yarn ``` -### Running +### Create `.env` + +```env +GH_TOKEN={YOUR_GITHUB_TOKEN_HERE} +DISCORD_TOKEN={YOUR_DISCORD_TOKE_HERE} +``` + +### Run the command ```bash -yarn start discord-token= wargaming-application-id= +yarn dev:bot ```