docs(README): add example
All checks were successful
Lint Markdown files / markdown-lint (push) Successful in 13s
Update Docker Hub Description / update-description-on-hub-docker-io (push) Successful in 7s
Build / build-amd64 (push) Successful in 49s
Build / build-arm64 (push) Successful in 1m12s

This commit is contained in:
Markus Pesch 2025-05-12 22:24:22 +02:00
parent 7d7e755995
commit 77b25f9b59
Signed by: volker.raschek
GPG Key ID: 852BCC170D81A982

View File

@ -6,5 +6,19 @@ This project contains all sources to build the container image `git.cryptic.syst
of this project is to package the binary `jq` as container image. The source code of the binary can be found in the of this project is to package the binary `jq` as container image. The source code of the binary can be found in the
upstream project of [adrienverge](https://github.com/adrienverge/jq). upstream project of [adrienverge](https://github.com/adrienverge/jq).
The workflow or how `jq` can in general be used is documented The workflow or how `jq` can in general be used is documented [here](https://jq.readthedocs.io/en/stable/). An example
[here](https://jq.readthedocs.io/en/stable/). how to use this image and read a JSON file from stdin is documented below. Pleas adapt the path of the JSON file.
```bash
# read file (stdin)
docker run \
--interactive \
--rm \
git.cryptic.systems/volker.raschek/jq:latest < /etc/docker/daemon.json
# cat (stdin)
cat /etc/docker/daemon.json | docker run \
--interactive \
--rm \
git.cryptic.systems/volker.raschek/jq:latest
```