From da0a8b9c298b3d1d1e44ff3812d09c730156e17e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micka=C3=ABl=20R=C3=A9mond?= <mremond@process-one.net>
Date: Thu, 16 May 2019 18:09:39 +0200
Subject: [PATCH] Add readme for XMPP check domain

---
 cmd/xmpp-check/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 cmd/xmpp-check/README.md

diff --git a/cmd/xmpp-check/README.md b/cmd/xmpp-check/README.md
new file mode 100644
index 0000000..43a8df8
--- /dev/null
+++ b/cmd/xmpp-check/README.md
@@ -0,0 +1,28 @@
+# XMPP Check
+
+XMPP check is a tool to check TLS certificate on a remote server.
+
+## Installation
+
+```
+$ go get -u gosrc.io/xmpp/cmd/xmpp-check
+```
+
+## Usage
+
+If you server is on standard port and XMPP domains matches the hostname you can simply use:
+
+```
+$ xmpp-check myhost.net:5222 xmppdomain.net
+2019/05/16 16:04:36 All checks passed
+```
+
+You can also pass the port and the XMPP domain if different from the server hostname:
+
+```
+$ xmpp-check myhost.net:5222 xmppdomain.net
+2019/05/16 16:04:36 All checks passed
+```
+
+Error code will be non-zero in case of error. You can thus use it directly with your usual 
+monitoring scripts.