From 98b4622bd5e52e84f60bc12ac91ed0090a85fee7 Mon Sep 17 00:00:00 2001 From: Azrea Amis Date: Sat, 8 May 2021 21:38:22 +0000 Subject: [PATCH] Add Docker info to README --- README.markdown | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.markdown b/README.markdown index f806efa..d09b260 100644 --- a/README.markdown +++ b/README.markdown @@ -127,6 +127,21 @@ Adding new site handers To add support for a new site, create a file in the `sites` directory that implements the `Site` interface. Take a look at `ao3.py` for a minimal example of what you have to do. +Docker +--- + +You can build the project's Docker container like this: + +```shell +docker build . -t kemayo/leech:snapshot +``` + +The container's entrypoint runs `leech` directly and sets the current working directory to `/work`, so you can mount any directory there: + +```shell +docker run -it --rm -v ${DIR}:/work kemayo/leech:snapshot download [[URL]] +``` + Contributing ---