Add basic README and ASCII logo
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2022-08-25 22:54:08 +02:00
parent 94c126e32b
commit 1f12dcbb1c
3 changed files with 43 additions and 1 deletions

15
README.MD Normal file
View File

@@ -0,0 +1,15 @@
# HidekoBot
Hideko is a general-purpose Discord bot.
## Startup
Download a prebuilt JAR file or build it from source, then run it with:
```bash
java -jar HidekoBot.jar botToken
```
Where `HidekoBot.jar` is the executable archive and `botToken` is your bot token passed as an argument.
## Initial setup
After starting the bot up successfully, it will print an invite-link in your console. Click on the link to add your bot
to any server with the correct permissions already set-up.