From 17453298efa828a0a0c04716cd3b479733345082 Mon Sep 17 00:00:00 2001 From: Kieran Date: Sun, 12 Jun 2022 10:54:11 +0100 Subject: [PATCH] Added docker commands --- .github/workflows/{main.yml => publish.yml} | 0 README.md | 17 ++++++++++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) rename .github/workflows/{main.yml => publish.yml} (100%) diff --git a/.github/workflows/main.yml b/.github/workflows/publish.yml similarity index 100% rename from .github/workflows/main.yml rename to .github/workflows/publish.yml diff --git a/README.md b/README.md index d35331d..0628558 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,21 @@ This bot features multiple command types from: * Fun * General +### 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 +``` + ### Contributions While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome! -* [ ] Contributing guidlines are coming soon! \ No newline at end of file