From 77b25f9b59afc0b636ca3aa6257d417e7d7f603f Mon Sep 17 00:00:00 2001 From: Markus Pesch <markus.pesch@cryptic.systems> Date: Mon, 12 May 2025 22:24:22 +0200 Subject: [PATCH] docs(README): add example --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b08b77d..a815fe5 100644 --- a/README.md +++ b/README.md @@ -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 upstream project of [adrienverge](https://github.com/adrienverge/jq). -The workflow or how `jq` can in general be used is documented -[here](https://jq.readthedocs.io/en/stable/). +The workflow or how `jq` can in general be used is documented [here](https://jq.readthedocs.io/en/stable/). An example +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 +```