Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/Magi3r/pin-bot
Browse files Browse the repository at this point in the history
  • Loading branch information
Magi3r committed Oct 2, 2023
2 parents d3870f1 + 81acf7f commit 16a1ec6
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,15 @@ There are a couple of ways on how to run `pin-bot`:
npx ts-node
```

A docker image is also planned.
If you want to use the docker image, simply run:
```bash
docker run -d --name pin-bot --restart unless-stopped -e TOKEN=<your-token> magi3r/pin-bot:latest
```
If you prefer alpine because of the slightly smaller image size, run:
```bash
docker run -d --name pin-bot --restart unless-stopped -e TOKEN=<your-token> magi3r/pin-bot:alpine
```

## Usage
You need to provide a discord bot token. You can get one from the [developer portal](https://discord.com/developers/applications) by creating a new application. You can either provide it as:
- an environmental variable
Expand All @@ -64,4 +72,4 @@ You also need to deploy the commands (although only once). This is done by runni
```bash
node bot.js -u
```
You still need to provide a token for this and the bot will start automatically after this.
You still need to provide a token for this and the bot will start automatically after this.

0 comments on commit 16a1ec6

Please sign in to comment.