Polished the document

This commit is contained in:
soulmachine 2016-08-01 13:14:51 -07:00
commit eb38af7083

View file

@ -1,5 +1,12 @@
This docker image wraps [shellcheck](https://github.com/koalaman/shellcheck) as a single executable.
How to use it? For example, you have a shell script named `sample.sh` under the current directory, you can lint it by running:
## Build the image
cd shellcheck/docker
docker build -t shellcheck .
## How to use it
For example, you have a shell script named `sample.sh` under the current directory, you can lint it by running:
docker run -v $(pwd):/tmp/work shellcheck /tmp/work/sample.sh