From 3e56f82205140d2df77b8ce4d9ac88fa57aca797 Mon Sep 17 00:00:00 2001 From: Yann Ponzoni Date: Tue, 6 May 2025 18:33:27 +0200 Subject: [PATCH] Add Docker usage example to README This commit updates the README to include an example of how to use the tool with Docker. It provides a clear command to run the container for checking SQL files without requiring installation. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index de878a2f..9298c481 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,15 @@ pip install squawk-cli https://github.com/sbdchd/squawk/releases ``` +### Without installation (Docker) + +You can run Squawk without installation using Docker. The official image is available on GitHub Container Registry. + +```shell +# Assuming you want to check sql files in the current directory +docker run --rm -v $(pwd):/data ghcr.io/sbdchd/squawk:latest *.sql +``` + ## Usage ```shell