From e6a7aa780e477311c78217b5b339ffa5d7926a83 Mon Sep 17 00:00:00 2001 From: mcinj <98779161+mcinj@users.noreply.github.com> Date: Fri, 22 Apr 2022 14:32:55 -0400 Subject: [PATCH] README update --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index e24df00..e904bcd 100644 --- a/README.md +++ b/README.md @@ -25,5 +25,29 @@ pip install -r requirements.txt python src/cli.py ``` +### Docker + +#### Run it using a hub.docker.com image +```bash +# Run the container +docker run --name steamgifts -d -it mcinj/docker-steamgifts-bot:latest +# Attach to it to fill in the questions +docker attach steamgifts # to detach, you must use ctrl+p then ctrl+q. + # ctrl+c will kill the container +``` + +#### Or build it yourself locally +```bash +# Build the image +docker build -t steamgifts:latest . +# Run the container +docker run --name steamgifts -d -it steamgifts:latest +# Attach to it to fill in the questions +docker attach steamgifts # to detach, you must use ctrl+p then ctrl+q. + # ctrl+c will kill the container +``` + + + ### Help Please leave your feedback and bugs in `Issues` page.