commit 73362af0a382b04afe12c9eb7979c580f08e45ed
parent 5a78e23c0653f840ca4aff08311f74cada03fa0f
Author: Daniel Gultsch <daniel@gultsch.de>
Date: Wed, 12 Apr 2017 13:09:10 +0200
Merge pull request #95 from M1dgard/patch-1
Fix Markdown headers in README
Diffstat:
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -5,14 +5,15 @@ Use this tool to test your XMPP server for compatibility with various compliance
You can easily mix and match various test cases to compose your own compliance suite or you can use a preexisting compliance suite.
-###Why compliance?
+## Why compliance?
+
XMPP is an extensible and living standard. Requirments shift over time and thus new extensions (called XEPs) get developed. While server implementors usually react quite fast and are able to cater to those needs it's the server operators who don't upgrade to the latest version or don't enable certain features.
Picking the right extensions to implement or enable isn't always easy. For this reason the XSF has published [XEP-0375 XMPP Compliance Suites](https://xmpp.org/extensions/xep-0375.html) listing the most important extensions to date.
This tool helps you to asses if your server supports those compliance profiles. It will also test for the slightly more comprehensive *Conversations compliance suite*. [Conversations](https://conversations.im) is the technology leader in mobile XMPP instant messaging and aims to provide its user with an experience that is a par with proprietary instant messaging solutions.
-###Usage
+## Usage
Download the compiled [ComplianceTester-0.1.jar](https://gultsch.de/files/ComplianceTester-0.1.jar) or build with ```mvn package``` (needs Java 8)
@@ -43,7 +44,7 @@ This tool will save your accounts and passwords into a file called ```accounts.x
There is also a very tiny wrapper script called ```runall.sh``` invoking that will run the compliance tester with all known accounts and save the output to ```reports/$servername```.
-###Reports
+## Reports
Full reports can be found in the directory ```reports```. Please create a pull request if you want your server to be included.
Submitted data can be processed and [displayed in a table](https://gultsch.de/compliance.html).
