Browse code
Update documentation to reflect deprecation of "NewEnvClient"
As `NewEnvClient` is deprecated in favor of `NewClientWithOpts`, the main package documentation should reflect this. This is also the text that appears on godoc.org so it's quite important that it is correct (for newbies like me)
Signed-off-by: Tobias Pfandzelter <pfandzelter@campus.tu-berlin.de>
Tobias Pfandzelter authored on 2020/10/03 22:07:07Showing 1 changed files
| ... | ... |
@@ -7,8 +7,8 @@ https://docs.docker.com/engine/reference/api/ |
| 7 | 7 |
Usage |
| 8 | 8 |
|
| 9 | 9 |
You use the library by creating a client object and calling methods on it. The |
| 10 |
-client can be created either from environment variables with NewEnvClient, or |
|
| 11 |
-configured manually with NewClient. |
|
| 10 |
+client can be created either from environment variables with NewClientWithOpts(client.FromEnv), |
|
| 11 |
+or configured manually with NewClient(). |
|
| 12 | 12 |
|
| 13 | 13 |
For example, to list running containers (the equivalent of "docker ps"): |
| 14 | 14 |
|