Skip to content
Snippets Groups Projects
Commit cf732895 authored by Riccardo Boero's avatar Riccardo Boero :innocent:
Browse files

Fixed CI/Cd error and READMe updates

parent 7f3e7b80
No related branches found
No related tags found
No related merge requests found
......@@ -18,8 +18,6 @@ test:
- julia --project=. -e 'using Test; include("test/runtest.jl")' # Run the tests
only:
- main
tags:
- docker # Optional: tag for specific runners that support Docker
# Documentation stage
build documentation:
......
# DockerJuliaClient
A Julia package to communicate with docker (or podman) daemons through the unix socket and according to the [Docker Remote API v1.40](https://docs.docker.com/engine/api/v1.40). It offers the possibility to access multiple registries and to manage both images and containers.
<div style="display: flex; align-items: center;">
<div style="flex: 1; padding-right: 10px;">
A Julia package to communicate with Docker (or Podman) daemons through the unix socket and according to the
<a href="https://docs.docker.com/engine/api/v1.40">Docker Remote API v1.40</a>. It offers the possibility
to access multiple registries and to manage both images and containers.
</div>
<div>
<img src="logo.png" alt="logo" width="100" />
</div>
</div>
<img src="logo.png" alt="logo" width="300"/>
---
[![GitLab License](https://img.shields.io/gitlab/license/fact%2Futils%2FJuliaDockerClient?gitlab_url=https%3A%2F%2Fgit.nilu.no&style=flat&color=orange)](https://www.gnu.org/licenses/agpl-3.0.en.html#license-text)
[![DOI](https://img.shields.io/badge/DOI-10.17605%2FOSF.IO%2FJWQYT-blue?style=flat)](https://doi.org/10.17605/OSF.IO/JWQYT)
---
## Use
1. To install the package in your project:
```julia
using Pkg
Pkg.add("https://git.nilu.no/fact/utils/JuliaDockerClient.git")
```
2. To use the package:
```julia
using JuliaDockerClient
``````
Please refer to the APIs accessible in the documentation section: https://fact.pages.nilu.no/utils/JuliaDockerClient/
---
## Specifications
The software implements version 1.40 fo Docker APIs to preserve full compatibility with Docker and Podman daemons. https://docs.docker.com/engine/api/v1.40
The software implements version 1.40 fo Docker APIs to preserve full compatibility with both Docker and Podman daemons. https://docs.docker.com/engine/api/v1.40
---
## Notes
---
### Authors
## Author
Riccardo Boero - ribo@nilu.no
### License
## License
[![AGPL v3](https://www.gnu.org/graphics/agplv3-88x31.png "License Icon")](https://www.gnu.org/licenses/agpl-3.0.en.html#license-text)
## Citation
- Boero, Riccardo. 2024. “FACT Utils: Docker Julia Client.” OSF. [doi:10.17605/OSF.IO/JWQYT](https://doi.org/10.17605/OSF.IO/JWQYT).
Part of the Fine scAle eConomic daTa - FACT project:
- Boero, Riccardo. 2024. “Fine scAle eConomic daTa - FACT.” OSF. [doi:10.17605/OSF.IO/PV4ZW](https://doi.org/10.17605/OSF.IO/PV4ZW).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment