You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,19 @@
2
2
3
3
This library allows you to interact with [Docker Remote API][docker-remote-api] endpoints in your .NET applications.
4
4
5
-
It is fully asynchronous, designed to be non-blocking and object-oriented way to interact with your Docker daemon programmatically. Currently, it supports [Docker Remote API v1.16][v1.16].
5
+
It is fully asynchronous, designed to be non-blocking and object-oriented way to interact with your Docker daemon programmatically.
6
+
7
+
**Versioning:** For example, `v2.124.0` supports `v1.24` of Docker Remote API.
6
8
7
9
## Installation
8
10
9
-
You can add this library to your project using [NuGet][nuget]. This is the only method this library is currently distributed unless you choose to build your own binaries using source code. Run the following command in the “Package Manager Console”:
11
+
You can add this library to your project using [NuGet][nuget]. This is the only method this library is currently distributed unless
12
+
you choose to build your own binaries using source code. Run the following command in the “Package Manager Console”:
10
13
11
14
PM> Install-Package Docker.DotNet
12
15
13
-
Or right click to your project in Visual Studio, choose “Manage NuGet Packages” and search for ‘Docker.DotNet’ and click ‘Install’. ([see NuGet Gallery][nuget-gallery].)
16
+
Or right click to your project in Visual Studio, choose “Manage NuGet Packages” and search for ‘Docker.DotNet’ and click ‘Install’.
#### Example: Create an image by pulling from Docker Registry
35
39
36
-
The code below pulls `fedora/memcached` image to your Docker instance using your Docker Hub account. You can anonymously download the image as well by passing `null` instead of AuthConfig object:
40
+
The code below pulls `fedora/memcached` image to your Docker instance using your Docker Hub account. You can
41
+
anonymously download the image as well by passing `null` instead of AuthConfig object:
@@ -68,11 +73,14 @@ var stopped = await client.Containers.StopContainerAsync ("39e3317fd258",
68
73
CancellationToken.None);
69
74
```
70
75
71
-
Above, the `Wait` field is of type `TimeSpan?` which means optional. This code will wait 30 seconds before killing it. If you like to cancel the waiting, you can use the CancellationToken parameter.
76
+
Above, the `Wait` field is of type `TimeSpan?` which means optional. This code will wait 30 seconds before
77
+
killing it. If you like to cancel the waiting, you can use the CancellationToken parameter.
72
78
73
79
#### Example: Dealing with Stream responses
74
80
75
-
Some Docker API endpoints are designed to return stream responses. For example [Monitoring Docker events](https://docs.docker.com/reference/api/docker_remote_api_v1.13/#monitor-dockers-events) continuously streams the status in a format like :
81
+
Some Docker API endpoints are designed to return stream responses. For example
@@ -153,9 +161,13 @@ Here are typical exceptions thrown from the client library:
153
161
154
162
## Versioning
155
163
156
-
Development of this client library was initially based on [Docker Remote API v1.14][v1.14]. Its forward compatibility is dependent on Docker's policy on forward compatibility. Feel free to send pull requests as the API changes over time. Please refer to the Changelog below to see what version of Docker Remote API is currently supported.
164
+
Version if this package uses SemVer format: `MAJOR.MINOR.PATCH`. MINOR segment indicates
165
+
the Docker Remote API version support. For instance `v2.124.0` of this library supports
166
+
Docker Remote API `v1.24`. This does not guarantee backwards compatibility as Docker Remote
167
+
API does not guarantee that either.
157
168
158
-
Backwards compatibility is not tested and therefore not guaranteed.
169
+
MAJOR is preserved for major breaking changes we make to the library itself such as how
170
+
the calls are made or how authentication is made. PATCH is just for incremental fixes.
159
171
160
172
## Changelog
161
173
@@ -261,7 +273,6 @@ This work is licensed under [Apache 2.0 License](LICENSE). Copyright 2014 Ahmet
0 commit comments