From 6c24b7f833eb39390962b723112f62881ed5d4c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Motiejus=20Jak=C5=A1tys?= Date: Mon, 24 May 2021 00:11:58 +0300 Subject: [PATCH] update README --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c6c2d1d..703e2a9 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Download `nginx` docker image from docker hub and convert it to a rootfs: ``` skopeo copy docker://docker.io/busybox:latest docker-archive:busybox.tar -undocker rootfs busybox.tar - | tar -xv +undocker busybox.tar - | tar -xv ``` Almost the same can be done with a combination of `docker pull` and `docker @@ -55,14 +55,25 @@ Good things like `PrivateUsers`, `DynamicUser`, `ProtectProc` and other Notes & gotchas --------------- -`unocker` does not magically enable you to run containers from the internet. In -fact, many will need significant tuning or not work at all. Thus you will still -need to understand what are you running. +`unocker` does not magically enable you to run containers from the internet. +Many will need significant tuning or not work at all. Thus you will still need +to understand what are you running. Contributions ------------- -I will accept pull request for code (including tests) and documentation. I am -unlikely to react to issue reports without a patch. +I want this project to be useful for others, but not become a burden for me. If +undocker fails for you (for example, you found a container that undocker cannot +extract, or extracts incorrectly), **you** are on the hook to triage and fix +it. + +Therefore, the following contributions are welcome: + +- Pull rquests (diffs) with accompanying tests. +- Documentation. + +Issues without accompanying patches will most likely be rejected, with one +exception: reports about regressions do not have to contain patches, but a +failing commit is mandatory, and a failing test case is highly appreciated. [1]: https://www.freedesktop.org/software/systemd/man/systemd.exec.html