add little readme

This commit is contained in:
Jonathan de Jong 2023-01-26 18:28:33 +01:00
parent b158896396
commit e13dc7c14a

13
complement/README.md Normal file
View file

@ -0,0 +1,13 @@
# Running Conduit on Complement
This assumes that you're familiar with complement, if not, please readme
[their readme](https://github.com/matrix-org/complement#running).
Complement works with "base images", this directory (and Dockerfile) helps build the conduit complement-ready docker
image.
To build, `cd` to the base directory of the workspace, and run this:
`docker build -t complement-conduit:dev -f complement/Dockerfile .`
Then use `complement-conduit:dev` as a base image for running complement tests.