Skip to content

Commit 24efaf2

Browse files
committed
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.
1 parent f91e45b commit 24efaf2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ pip install squawk-cli
2020
# or install binaries directly via the releases page
2121
https://github.com/sbdchd/squawk/releases
2222
```
23+
### Without installation (Docker)
24+
25+
You can run Squawk without installation using Docker. The official image is available on GitHub Container Registry.
26+
27+
```shell
28+
# Assuming you want to check sql files in the current directory
29+
docker run --rm -v $(pwd):/data ghcr.io/sbdchd/squawk:latest *.sql
30+
```
2331

2432
## Usage
2533

0 commit comments

Comments
 (0)