diff --git a/README.md b/README.md index 31e23ae..ba74180 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,30 @@ Simple wrapper for [broken-link-checker](https://github.com/stevenvachon/broken-link-checker) optimized for CI. +## Usage + +```Shell +docker run -v $(pwd)/public:/drone/src link-validator + +# or pass arguments to broken-link-checker +# ... but DO NOT set the server url! This will be done automatically. See environment variables. +docker run -v $(pwd)/public:/drone/src link-validator -ro +``` + +## Environment variables + +```Shell +LINK_VALIDATOR_BASE_DIR=/drone/src +LINK_VALIDATOR_SERVER_ADDRESS=127.0.0.1 +LINK_VALIDATOR_SERVER_PORT=8000 +``` + +## Build + +```Shell +docker build -t link-validator:latest . +``` + ## License This project is licensed under the MIT License - see the [LICENSE](https://gitea.rknet.org/docker/link-validator/src/branch/master/LICENSE) file for details.