diff --git a/README.md b/README.md index 9c466de..b682550 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,11 @@ This repository packages [Wohnungsbot](https://github.com/neopostmodern/wohnungs ## How to use ### Default use case + +Using the prebuilt image: + ``` -docker build -t wohnungsbot https://github.com/Wyrrrd/docker-wohnungsbot.git -docker run -td -p 6080:6080 wohnungsbot +docker run -td -p 6080:6080 wyrrrd/docker-wohnungsbot:latest ``` The interface is then available under http://privateip:6080 @@ -17,11 +19,17 @@ If the bot gets stuck, press ESC to restart it. ### Advanced use case -You can build a specific tag of [Wohnungsbot](https://github.com/neopostmodern/wohnungsbot) by using the following syntax. The data is generally automatically persisted in an unnamed docker volume, but that volume can also be named. +You can also build it yourself. The data is generally automatically persisted in an unnamed docker volume, but that volume can also be named. ``` -docker build -t wohnungsbot --build-arg WB_VERSION=1.4.0 https://github.com/Wyrrrd/docker-wohnungsbot.git -docker run -td -p 6080:6080 -v wohnungsbot_data:/data wohnungsbot +docker build -t docker-wohnungsbot https://github.com/Wyrrrd/docker-wohnungsbot.git +docker run -td -p 6080:6080 -v wohnungsbot_data:/data docker-wohnungsbot +``` + +You can even build a specific tag of [Wohnungsbot](https://github.com/neopostmodern/wohnungsbot) by using the following syntax. + +``` +docker build -t docker-wohnungsbot --build-arg WB_VERSION=1.4.0 https://github.com/Wyrrrd/docker-wohnungsbot.git ``` If you are limiting the available memory for your containers, 500m should be enough. It is a GUI application after all.