Added manual
parent
4e679e313b
commit
9e10dab7ce
17
README.md
17
README.md
|
@ -9,12 +9,11 @@ This bot features multiple command types from:
|
||||||
|
|
||||||
---
|
---
|
||||||
## Installation
|
## 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.**
|
### 🐋 Docker
|
||||||
|
|
||||||
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.
|
Due to the [Publish.yml](.github/workflows/publish.yml) workflow, the newest build will automatically be pushed to dockerhub.
|
||||||
|
|
||||||
```docker
|
```docker
|
||||||
docker run -d \
|
docker run -d \
|
||||||
--name=hullcss \
|
--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.
|
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 = <Discord Token>
|
||||||
|
PREFIX = !
|
||||||
|
```
|
||||||
|
- Run `npm i`
|
||||||
|
- Run node .
|
||||||
|
|
||||||
---
|
---
|
||||||
## Contributions
|
## Contributions
|
||||||
While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome!
|
While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome!
|
||||||
|
|
Loading…
Reference in New Issue