diff --git a/README.md b/README.md index 6476af7..95a5de2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -# Twitch Drops Miner +# Twitch Drops Miner - Docker version + +This is a fork of [DevilXD/TwitchDropsMiner](https://github.com/DevilXD/TwitchDropsMiner), adding Docker support. \ +Copy the `.env.example` to `.env` and adjust the port as needed. \ +Then run `docker compose up -d --build` and connect via VNC to your port. + +## Twitch Drops Miner This application allows you to AFK mine timed Twitch drops, without having to worry about switching channels when the one you were watching goes offline, claiming the drops, or even receiving the stream data itself. This helps you save on bandwidth and hassle.