hullcss-discord-bot/README.md

28 lines
858 B
Markdown
Raw Normal View History

2022-05-11 12:44:44 +01:00
# HullCSS Discord Bot
> This bot is a multipurpose discord bot for The Hull Computer Science Society Discord server.
This bot features multiple command types from:
* Admin
* Embeds
* Fun
* General
2022-06-12 10:54:11 +01:00
### Installation
**This is a private bot used for a specific purpose within a specific discord server.**
However if you do want to run the bot for testing purposes or deploy it to a new container. Run the below command to run the bot.
Due to the [Publish.yml](.github/workflows/publish.yml) workflow, the newest build will automatically be pushed to dockerhub.
```docker
docker run -d \
--name=hullcss \
-p 6001:6001 \
-e DISCORD_TOKEN='INSERT DISCORD TOKEN' \
-e PREFIX='!' \
--restart unless-stopped \
kieranr27/hullcss:latest
```
2022-05-11 12:44:44 +01:00
### Contributions
While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome!