Add example to readme

This commit is contained in:
2025-05-21 16:36:49 +02:00
parent 7a84ada939
commit 179b035c44

View File

@@ -14,6 +14,30 @@ All images are exposed to `http://0.0.0.0:8000/all` in JSON format.
If you want to get only images needing update, look at `http://0.0.0.0:8000/updates`.
Here is a quick example of what you get on the `/all` endpoint (dockup don't have local tag because it is a locally built image):
```json
[
{
"name": "dockup",
"repo": "dockup-dockup",
"local_tag": "latest",
"remote_tag": null
},
{
"name": "wikijs-wiki-1",
"repo": "ghcr.io/requarks/wiki",
"local_tag": "2.5.307",
"remote_tag": "2.5.307"
},
{
"name": "wikijs-db-1",
"repo": "postgres",
"local_tag": "17.4-alpine",
"remote_tag": "17.5-alpine"
}
]
```
# Requirements
This program needs [regctl](https://github.com/regclient/regclient.git).
It is shipped with container image by default, however you'll need to install it by yourself if running script directly.