Skip to content

Commit

Permalink
Update docker run section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jasper-Ben committed Sep 12, 2022
1 parent 761eea7 commit 37f7544
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,11 @@ Place the binary in a folder, shined upon by your `$PATH`.
Alternatively to installing the todocheck binary on your system you may use a prebuilt container image from the GitHub container registry, e.g.:

```bash
docker run -it ghcr.io/preslavmihaylov/todocheck
docker run -it -v /path/to/project:/project -e TODOCHECK_AUTH_TOKEN=your_token ghcr.io/preslavmihaylov/todocheck --basepath /project
```

For a complete list of container tags visit the `Packages` section on the GitHub project page.
For a complete list of container tags visit the [Packages section](https://github.com/preslavmihaylov/todocheck/pkgs/container/todocheck) on the GitHub project page.
For a complete list of `docker run` options visit the [Docker documentation](https://docs.docker.com/engine/reference/commandline/run/).

# Quickstart
First, you need to configure `todocheck`'s integration with your issue tracker.
Expand Down

0 comments on commit 37f7544

Please sign in to comment.