Skip to content

Commit

Permalink
added README's to img and runc
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Henry <ihenry@chef.io>
  • Loading branch information
Ian Henry committed Mar 14, 2018
1 parent 617d9f9 commit aebe069
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
14 changes: 14 additions & 0 deletions 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
```
14 changes: 14 additions & 0 deletions 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
```

0 comments on commit aebe069

Please sign in to comment.