add intro text
All checks were successful
Rust / build (push) Successful in 56s
Rust / test (push) Successful in 51s
Rust / clippy (push) Successful in 39s
Rust / fmt (push) Successful in 42s
Rust / pre-commit (push) Successful in 44s
Rust / build (pull_request) Successful in 46s
Rust / test (pull_request) Successful in 47s
Rust / clippy (pull_request) Successful in 44s
Rust / fmt (pull_request) Successful in 38s
Rust / pre-commit (pull_request) Successful in 42s

This commit is contained in:
2024-06-07 14:45:49 +02:00
parent 2c42c6769b
commit 367b3adf09

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: