summary refs log tree commit diff
diff options
context:
space:
mode:
authorRichard van der Hoff <github@rvanderhoff.org.uk>2018-01-16 13:18:17 +0000
committerGitHub <noreply@github.com>2018-01-16 13:18:17 +0000
commit5b527d7ee18e63528d0df9162510bb8f553f5815 (patch)
treeca4442b3563964a774180ff4ca70dd6181f594a5
parentMerge branch 'release-v0.26.0' of github.com:matrix-org/synapse (diff)
parentMention SyTest in the README, after Development (diff)
downloadsynapse-5b527d7ee18e63528d0df9162510bb8f553f5815.tar.xz
Merge pull request #2674 from her001/readme-sytest
Mention SyTest in the README, after Development
Diffstat (limited to '')
-rw-r--r--README.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 76fe2e4139..ef1eed4584 100644
--- a/README.rst
+++ b/README.rst
@@ -890,6 +890,17 @@ This should end with a 'PASSED' result::
 
     PASSED (successes=143)
 
+Running the Integration Tests
+=============================
+
+Synapse is accompanied by `SyTest <https://github.com/matrix-org/sytest>`_,
+a Matrix homeserver integration testing suite, which uses HTTP requests to
+access the API as a Matrix client would. It is able to run Synapse directly from
+the source tree, so installation of the server is not required.
+
+Testing with SyTest is recommended for verifying that changes related to the
+Client-Server API are functioning correctly. See the `installation instructions
+<https://github.com/matrix-org/sytest#installing>`_ for details.
 
 Building Internal API Documentation
 ===================================