Skip to content

Commit

Permalink
update readme with new --help
Browse files Browse the repository at this point in the history
Signed-off-by: Yves Brissaud <[email protected]>
  • Loading branch information
eunomie committed Oct 17, 2024
1 parent 28c8444 commit 474d11c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ This is a collection of [docker runx](https://github.com/eunomie/runx) compatibl

Those images can be used without `runx`, like with `docker run` or `docker compose` for instance. In this case they are just mirrors of the official images.

Explore the documentation of each image to know more and learn how to use them with `docker runx IMAGE --docs`.
Explore the documentation of each image to know more and learn how to use them with `docker runx IMAGE --help`.

List the available commands using `docker runx IMAGE --list` or get detailed information about an action using `docker runx IMAGE ACTION --docs`.
List the available commands using `docker runx IMAGE --list` or get detailed information about an action using `docker runx IMAGE ACTION --help`.

Then simply run the image with `docker runx IMAGE [ACTION]`.

## Images

- [golangci-lint](./golangci-lint): A Docker image for [golangci-lint](https://golangci-lint.run/) with some defaults and caching enabled
```
$ docker runx eunomie/golangci-lint --docs
$ docker runx eunomie/golangci-lint --help
```
- [scout-cli](./scout-cli): A Docker image for [Docker Scout CLI](https://docs.docker.com/engine/reference/commandline/scout/) to showcase how to use it
```
$ docker runx eunomie/scout-cli --docs
$ docker runx eunomie/scout-cli --help
```
Images are available on [Docker Hub](https://hub.docker.com/u/eunomie).

0 comments on commit 474d11c

Please sign in to comment.