Skip to content
This repository was archived by the owner on Nov 24, 2024. It is now read-only.

Commit c4b4f5d

Browse files
committed
Update readme
1 parent 60b6b73 commit c4b4f5d

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
This is a Docker Client written in Swift. It's using the NIO Framework to communicate with the Docker Engine via sockets.
66

7+
78
## Current Use Cases
89
- [x] List of all images
910
- [x] List of all containers
@@ -39,6 +40,7 @@ let package = Package(
3940
To add DockerClientSwift to your existing Xcode project, select File -> Swift Packages -> Add Package Depedancy.
4041
Enter `https://github.com/alexsteinerde/docker-client-swift.git` for the URL.
4142

43+
4244
## Usage Example
4345
```swift
4446
let client = DockerClient()
@@ -49,16 +51,25 @@ let output = try container.logs(on: client).wait()
4951
print(output)
5052
```
5153

52-
For further usage examples, please consider looking at the provided test cases.
54+
For further usage examples, please consider looking at the provided test cases. Or have a look at the demo projects in the next section.
55+
If you want to read more about this package, feel free to read my [blog article](https://alexsteiner.de/blog/posts/docker-client-package-with-swift/) about it.
5356

5457
## Demo
55-
There are two demo applications. One for the usage as a [Mac app](https://github.com/alexsteinerde/docker-client-swift-mac-app) and one in an [Vapor environment on the server](https://github.com/alexsteinerde/docker-client-vapor-demo).
58+
There are two demo applications.
59+
60+
|Project|Link|
61+
--- | --- | ---
62+
|Mac App|[https://github.com/alexsteinerde/docker-client-swift-mac-app](https://github.com/alexsteinerde/docker-client-swift-mac-app)|
63+
|Vapor App|[https://github.com/alexsteinerde/docker-client-vapor-demo](https://github.com/alexsteinerde/docker-client-vapor-demo)|
64+
5665

5766
## Security Advice
5867
When using this in production, make sure you secure your application so no others can execute code. Otherwise, the attacker could access your Docker environment and so all of the containers running in it.
5968

69+
6070
## License
6171
This project is released under the MIT license. See [LICENSE](LICENSE) for details.
6272

73+
6374
## Contribution
6475
You can contribute to this project by submitting a detailed issue or by forking this project and sending a pull request. Contributions of any kind are very welcome :)

0 commit comments

Comments
 (0)