Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oleggator authored Aug 5, 2023
1 parent 74f7fa2 commit 13f911a
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
# discobot

# Discobot - Minimalistic Discord Music Bot
[![Build and deploy](https://github.com/oleggator/discobot/actions/workflows/fly.yml/badge.svg)](https://github.com/oleggator/discobot/actions/workflows/fly.yml)

## Requirements
Supports all services supported by [yt-dlp](https://github.com/yt-dlp/yt-dlp), including YouTube, SoundCloud, Twitch, TuneIn, etc.

## How to run

### With Docker

#### Pull from repository
```shell
docker run -it --rm -e TOKEN=DISCORD_BOT_TOKEN ghcr.io/oleggator/discobot:latest
```

- 1 core cpu
- 128 mb ram
#### Or build by yourself
Docker image is buildable for the next platforms: x86_64, x86, aarch64, armhf, s390x, armv7, ppc64le
```shell
docker build -t discobot .
```

## Dependencies
### Without Docker

## Prerequisites
- Go 1.20
- yt-dlp
- ffmpeg

## Docker image is compilable for the next platforms
x86_64, x86, aarch64, armhf, s390x, armv7, ppc64le
```shell
git clone https://github.com/oleggator/discobot.git
cd discobot
go build discobot
TOKEN=DISCORD_BOT_TOKEN ./discobot
```

0 comments on commit 13f911a

Please sign in to comment.