diff --git a/README.md b/README.md index b246e7e..99f6fa0 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,25 @@ # boco -Turning containers into bootable VMs +Turn container images into bootable VMs ## Example +```Dockerfile +FROM alpine:latest +CMD ["/bin/sh"] +``` + ```sh # Build the container podman build ./example/alpine -t boco-alpine -# Make the container bootable. boco injects /boco/init and /boco/exec, +# Make the container bootable. boco injects a custom init program, # then packs the rootfs as a qcow2 disk. boco build qcow2 boco-alpine -# Boot the image using QEMU. The container's CMD runs automatically. +# Boot the image using QEMU, and drop into /bin/sh. boco boot boco-alpine -# Override the command at runtime (base64-encoded on the kernel cmdline): -boco boot boco-alpine --cmd '/bin/sh' - -# Override the command at build time (baked into /boco/exec): -boco build qcow2 boco-alpine --cmd '/bin/sh' - # Cleanup boco image rm boco-alpine podman image rm boco-alpine