diff --git a/README.md b/README.md new file mode 100644 index 0000000..165dc5f --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +# + +Archives containing JAR files are available as [releases](https://github.com/intisy/docker-java/releases). + +## What is docker-java? + +Docker-java provides a standalone Docker server for Java. + +## Usage in private projects + + * Maven (inside the file) +```xml + + github + https://maven.pkg.github.com/intisy/docker-java + true + + + io.github.intisy + docker-java + 1.2.6.5 + +``` + + * Maven (inside the file) +```xml + + + github + your-username + your-access-token + + +``` + + * Gradle (inside the or file) +```groovy + repositories { + maven { + url "https://maven.pkg.github.com/intisy/docker-java" + credentials { + username = "" + password = "" + } + } + } + dependencies { + implementation 'io.github.intisy:docker-java:1.2.6.5' + } +``` + +## Usage in public projects + + * Gradle (inside the or file) +```groovy + plugins { + id "io.github.intisy.github-gradle" version "1.3.7" + } + dependencies { + githubImplementation "intisy:docker-java:1.2.6.5" + } +``` + +Once you have it installed you can use it like so: + +``` +DockerProvider dockerProvider = DockerProvider.get(); +dockerProvider.ensureInstalled(); +dockerProvider.start(); +DockerClient dockerClient = dockerProvider.getClient(); +``` + +Currently supported setups: + * [x] - Linux root + * [x] - Linux rootless + * [x] - Windows Administrator + * [x] - Windows non-Administrator + * [x] - macOS root + * [x] - macOS rootless + +## License + +[![Apache License 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)