From 9e10dab7ce30c36ba3380fd6d92a116973cfc071 Mon Sep 17 00:00:00 2001 From: Kieran Date: Sun, 12 Jun 2022 11:09:58 +0100 Subject: [PATCH] Added manual --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8301403..1d0807a 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,11 @@ This bot features multiple command types from: --- ## 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 location. Follow the instructions below.** -**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. - +### 🐋 Docker 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 \ @@ -27,6 +26,16 @@ kieranr27/hullcss:latest Using a tool like [Ouroboros](https://github.com/pyouroboros/ouroboros), you can automatically update containers without the need for restarts. +### 👷 Manual +- Clone the repo +- Create a `.env` file with the following lines: +``` +DISCORD_TOKEN = +PREFIX = ! +``` +- Run `npm i` +- Run node . + --- ## Contributions While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome!