Skip to content

Commit 4d1f301

Browse files
committed
Versioning note and readme cosmetics
1 parent 01e9ae2 commit 4d1f301

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22

33
This library allows you to interact with [Docker Remote API][docker-remote-api] endpoints in your .NET applications.
44

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.
68

79
## Installation
810

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”:
1013

1114
PM> Install-Package Docker.DotNet
1215

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’.
17+
([see NuGet Gallery][nuget-gallery].)
1418

1519
## Usage
1620

@@ -33,7 +37,8 @@ IList<ContainerResponse> containers = await client.Containers.ListContainersAsyn
3337

3438
#### Example: Create an image by pulling from Docker Registry
3539

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:
3742

3843
```csharp
3944
Stream stream = await client.Images.CreateImageAsync (new CreateImageParameters () {
@@ -68,11 +73,14 @@ var stopped = await client.Containers.StopContainerAsync ("39e3317fd258",
6873
CancellationToken.None);
6974
```
7075

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.
7278

7379
#### Example: Dealing with Stream responses
7480

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
82+
[Monitoring Docker events](https://docs.docker.com/reference/api/docker_remote_api_v1.13/#monitor-dockers-events)
83+
continuously streams the status in a format like :
7684

7785
```json
7886
{"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924}
@@ -153,9 +161,13 @@ Here are typical exceptions thrown from the client library:
153161

154162
## Versioning
155163

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.
157168

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.
159171

160172
## Changelog
161173

@@ -261,7 +273,6 @@ This work is licensed under [Apache 2.0 License](LICENSE). Copyright 2014 Ahmet
261273

262274
[docker-remote-api]: https://docs.docker.com/reference/api/docker_remote_api/
263275
[v1.14]: https://docs.docker.com/reference/api/docker_remote_api_v1.14/
264-
[v1.16]: https://docs.docker.com/reference/api/docker_remote_api_v1.16/
265276
[docker-tls]: https://docs.docker.com/articles/https/
266277
[nuget]: http://www.nuget.org
267278
[nuget-gallery]: https://www.nuget.org/packages/Docker.DotNet/

0 commit comments

Comments
 (0)