From 5fa4599142933b3beefb659089499c4dabf03e29 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Thu, 12 Oct 2023 16:38:07 +0200 Subject: [PATCH] docs: note about action usage --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index b6c7ef3..d0c78ba 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,13 @@ Works on Linux, macOS and Windows. > * https://github.com/crazy-max/ghaction-setup-docker/pull/53 > * https://github.com/docker/actions-toolkit/issues/317 +> [!NOTE] +> This action is useful if you want to pin against a specific Docker version or +> set up a custom daemon configuration or if Docker is not available on your +> runner. If you're using [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) +> on Linux or Windows, Docker is already up and running, so it might not be +> necessary to use this action. + ![Screenshot](.github/setup-docker-action.png) ___