Browse Source

client: update example in readme

The example still used the deprecated types.ContainerListOptions;
also slightly updated the example to show both stopped and running
containers, so that the example works even if no container is running.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn 1 year ago
parent
commit
8641d2da3b
1 changed files with 11 additions and 9 deletions
  1. 11 9
      client/README.md

+ 11 - 9
client/README.md

@@ -1,8 +1,10 @@
 # Go client for the Docker Engine API
 
-The `docker` command uses this package to communicate with the daemon. It can also be used by your own Go applications to do anything the command-line interface does – running containers, pulling images, managing swarms, etc.
+The `docker` command uses this package to communicate with the daemon. It can
+also be used by your own Go applications to do anything the command-line
+interface does – running containers, pulling images, managing swarms, etc.
 
-For example, to list running containers (the equivalent of `docker ps`):
+For example, to list all containers (the equivalent of `docker ps --all`):
 
 ```go
 package main
@@ -11,26 +13,26 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/docker/docker/api/types"
+	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/client"
 )
 
 func main() {
-	cli, err := client.NewClientWithOpts(client.FromEnv)
+	apiClient, err := client.NewClientWithOpts(client.FromEnv)
 	if err != nil {
 		panic(err)
 	}
-	defer cli.Close()
+	defer apiClient.Close()
 
-	containers, err := cli.ContainerList(context.Background(), types.ContainerListOptions{})
+	containers, err := apiClient.ContainerList(context.Background(), container.ListOptions{All: true})
 	if err != nil {
 		panic(err)
 	}
 
-	for _, container := range containers {
-		fmt.Printf("%s %s\n", container.ID[:10], container.Image)
+	for _, ctr := range containers {
+		fmt.Printf("%s %s (status: %s)\n", ctr.ID, ctr.Image, ctr.Status)
 	}
 }
 ```
 
-[Full documentation is available on GoDoc.](https://godoc.org/github.com/docker/docker/client)
+[Full documentation is available on pkg.go.dev.](https://pkg.go.dev/github.com/docker/docker/client)