From 04f9b7c23b411b424b2c67430fb24a0fffdac2f7 Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 27 Jan 2022 12:43:34 +0100 Subject: [PATCH] Add additional parameters for Docker usage example --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b3a802c..6d17341 100644 --- a/README.md +++ b/README.md @@ -175,10 +175,12 @@ acat -F zip {file.epub} "*.xhtml" "*.html" | lychee - ### Docker Usage Here's how to mount a local directory into the container and check some input -with lychee: +with lychee. The `--init` parameter is passed so that lychee can be stopped +from the terminal. We also pass `-it` to start an interactive terminal, which +is required to show the progress bar. ```sh -docker run -v `pwd`:/input lycheeverse/lychee /input/README.md +docker run --init -it -v `pwd`:/input lycheeverse/lychee /input/README.md ``` ### GitHub Token