summaryrefslogtreecommitdiff
path: root/complement/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'complement/README.md')
-rw-r--r--complement/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/complement/README.md b/complement/README.md
new file mode 100644
index 0000000..b86aab3
--- /dev/null
+++ b/complement/README.md
@@ -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.