jheuel/ohrwurm
1
0
Fork 0
Code Issues 1 Pull Requests 9 Actions Packages Projects Releases Wiki Activity

Improve readme #1

Merged
jheuel merged 2 commits from dev into main 2024-06-07 15:32:29 +02:00
Conversation 0 Commits 2 Files Changed 2 +5 -1
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 367b3adf09 - Show all commits

6
README.md
View File

@@ -5,8 +5,10 @@
Ohrwurm
</p>
Ohrwurm is a user-friendly bot designed to play music in Discord voice chats. Once added to your server, you can request a song using the command `/play {query}`, where query can be a URL to a YouTube video or playlist, or a simple search term. The bot will fetch the song and start playing it. You can pause the music with `/pause`, resume playback with `/resume`, and stop and clear the queue with `/stop`. If the bot is alone in a voice chat, it will automatically leave, but you can also manually make it leave with the `/leave` command.
# Deployment
To deploy Ohrwurm with Docker, you can use the provided Docker image:
To deploy Ohrwurm with Docker, you can use the [provided Docker](https://hub.docker.com/r/jheuel/ohrwurm) image:
```bash
docker run -d \
--name ohrwurm \
@@ -17,6 +19,8 @@ docker run -d \
jheuel/ohrwurm:latest
```
Alternatively, you can create a `docker-compose.yml` file:
```yaml
services: