# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1493810174 -3600
# Node ID e4381b6a52ce09b02e2ceba84ee2ed259fd8ac38
# Parent  1eb0534e81a23e8c5f39b73aaa6b27f4fc138303
Add README

diff -r 1eb0534e81a2 -r e4381b6a52ce README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Wed May 03 12:16:14 2017 +0100
@@ -0,0 +1,25 @@
+Introduction
+============
+
+This repository allows building the latest aioxmpp test suite into a convenient portable Docker image, which can
+be used to launch the tests inside a container, pointed towards the XMPP server of your choice.
+
+Building
+========
+
+In the repository, run:
+
+    docker build -t aioxmpp-tests .
+
+Running
+=======
+
+    docker run --rm -e SERVER_HOST=localhost -e SERVER_PORT=5222 aioxmpp-tests
+
+Limitations
+===========
+
+Currently only the anonymous provisioner is used, which requires anonymous authentication to be enabled
+on the server. For this reason it attempts to connect to the XMPP host 'anon.localhost', assuming this
+to allow anonymous authentication. If you need to specify a different XMPP host, this is currently not
+implemented, but patches welcome (it's trivial to do).