diff --git a/README.md b/README.md index 7c60b8ec0..af7eee900 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ print("\n\n".join([str(el) for el in elements])) The following instructions are intended to help you get up and running using Docker to interact with `unstructured`. See [here](https://docs.docker.com/get-docker/) if you don't already have docker installed on your machine. -NOTE: the image is only supported for x86_64 hardware and known to have issues on Apple silicon. +NOTE: we build multi-platform images to support both x86_64 and Apple silicon hardware. `docker pull` should download the corresponding image for your architecture, but you can specify with `--platform` (e.g. `--platform linux/amd64`) if needed. We build Docker images for all pushes to `main`. We tag each image with the corresponding short commit hash (e.g. `fbc7a69`) and the application version (e.g. `0.5.5-dev1`). We also tag the most recent image with `latest`. To leverage this, `docker pull` from our image repository. @@ -98,7 +98,7 @@ Once pulled, you can create a container from this image and shell to it. ```bash # create the container -docker run --platform linux/amd64 -d -t --name unstructured quay.io/unstructured-io/unstructured:latest +docker run -dt --name unstructured quay.io/unstructured-io/unstructured:latest # this will drop you into a bash shell where the Docker image is running docker exec -it unstructured bash