Skip to content

Commit 3e56f82

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 3e56f82

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@ pip install squawk-cli
2121
https://github.com/sbdchd/squawk/releases
2222
```
2323

24+
### Without installation (Docker)
25+
26+
You can run Squawk without installation using Docker. The official image is available on GitHub Container Registry.
27+
28+
```shell
29+
# Assuming you want to check sql files in the current directory
30+
docker run --rm -v $(pwd):/data ghcr.io/sbdchd/squawk:latest *.sql
31+
```
32+
2433
## Usage
2534

2635
```shell

0 commit comments

Comments
 (0)