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

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexsteinerde committed Apr 6, 2021
1 parent 60b6b73 commit c4b4f5d
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

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


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


## Usage Example
```swift
let client = DockerClient()
Expand All @@ -49,16 +51,25 @@ let output = try container.logs(on: client).wait()
print(output)
```

For further usage examples, please consider looking at the provided test cases.
For further usage examples, please consider looking at the provided test cases. Or have a look at the demo projects in the next section.
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.

## Demo
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).
There are two demo applications.

|Project|Link|
--- | --- | ---
|Mac App|[https://github.com/alexsteinerde/docker-client-swift-mac-app](https://github.com/alexsteinerde/docker-client-swift-mac-app)|
|Vapor App|[https://github.com/alexsteinerde/docker-client-vapor-demo](https://github.com/alexsteinerde/docker-client-vapor-demo)|


## Security Advice
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.


## License
This project is released under the MIT license. See [LICENSE](LICENSE) for details.


## Contribution
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 comments on commit c4b4f5d

Please sign in to comment.