diff --git a/README.md b/README.md index ce2bdd5..276868f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # vanity-bot +My personal simple python bot that I made to learn the language -My private simple python bot that I made to learn the language \ No newline at end of file +-------- + +Clone the repo with ```git clone https://git.efiyo.xyz/efiyo/vanity-bot``` + +Install requirements from requirements.txt via ```pip``` + +note that ```neofetch``` is also required for 1 command to function + +Make a bot at https://discord.com/developers/applications + +Enter your bot token into ```.env``` + +Run ```python bot.py``` + +Invite the bot to your server + +-------- + +It currently has basic funcionality via Discord slash commands such as: + +```/temp``` to check the temperature of the device + +```/neofetch``` to show the current specs of the machine it's running on, currently only Linux supported + +```/ping``` to show the current latency in ms of the bot + +```/roll``` to just roll a dice from 1-100