From 39e33e932b26cb75427f709af40b0458bac0448c Mon Sep 17 00:00:00 2001 From: Robert de Bock Date: Fri, 6 Jan 2017 06:04:00 +0100 Subject: [PATCH] Update README.md Adding a usage example for Docker. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index be0b913..45eed03 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,12 @@ From Docker Hub: docker pull koalaman/shellcheck +Using the Docker image can be done like so: + + docker run -v $(pwd):/scripts koalaman/shellcheck /sripts/myscript.sh + +Here the local directory ( $(pwd) ) is mounted into the containers directory "/scripts". The script "myscript.sh" is checked. + ## Compiling from source This section describes how to build ShellCheck from a source directory. ShellCheck is written in Haskell and requires 2GB of RAM to compile.