From aebe069a9f7de8af3d00baae55862436540d7e4a Mon Sep 17 00:00:00 2001 From: Ian Henry Date: Wed, 14 Mar 2018 11:03:39 -0400 Subject: [PATCH] added README's to img and runc Signed-off-by: Ian Henry --- img/README.md | 14 ++++++++++++++ runc/README.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 img/README.md create mode 100644 runc/README.md diff --git a/img/README.md b/img/README.md new file mode 100644 index 0000000000..7ecf6ba55b --- /dev/null +++ b/img/README.md @@ -0,0 +1,14 @@ +# Img +The `img` plan _only_ provides users access to the standalone [img binary](https://github.com/genuinetools/img). IMG unlike docker does not include a running daemon. Instead, it is meant to be executed as a binary for the creation of unprivilied OCI and Docker container images + +## Examples +To use the `img` binary you can follow two different patterns. You can either binlink the package to the underlying system, or you can use the `hab` binary to execute the `img` binary + +``` +$ hab pkg exec core/img img --help +``` +Or +``` +$ hab pkg binlink core/img img +$ img --help +``` diff --git a/runc/README.md b/runc/README.md new file mode 100644 index 0000000000..b1713e3cb6 --- /dev/null +++ b/runc/README.md @@ -0,0 +1,14 @@ +# Runc +The `runc` plan _only_ provides users access to the standalone [runc binary](https://github.com/opencontainers/runc). Runc unlike dockerd does not include a running daemon. Instead, it is meant to be executed as a binary or consumed as a library to manage OCI bundle containers. + +## Examples +To use the `runc` binary you can follow two different patterns. You can either binlink the package to the underlying system, or you can use the `hab` binary to execute the `img` binary + +``` +$ hab pkg exec core/runc runc --help +``` +Or +``` +$ hab pkg binlink core/runc runc +$ runc --help +```