diff --git a/README.md b/README.md index 470cf04dc1628b0b4c103aa2e1829a2e200ca180..fa16fa0a78124cfa46989886f57bf789bf9372de 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ +# Zipr via Docker + +Run our docker image by [installing Docker](https://docs.docker.com/get-docker/), then running: + +``` +docker run -it git.zephyr-software.com:4567/opensrc/zipr/zipr-bin +``` + +The image will prompt you how to proceed. To learn how to invoke and use Zipr transforms, see the [IRDB Cookbook Examples repository](https://git.zephyr-software.com/opensrc/irdb-cookbook-examples) section on using [transforms in Docker](https://git.zephyr-software.com/opensrc/irdb-cookbook-examples#docker-recommended). + # Building Zipr/Peasoup The instructions that follow assume that: -* you have access to both the Zipr and ZAFL repo +* you have access to both the Zipr repo * you have sudo privileges * you are installing in your home directory * you are using a recent version of Linux, e.g., Ubuntu 18.04