From 5cf68897999d33246d47ecaf5469d1f0f4b77b84 Mon Sep 17 00:00:00 2001
From: nico <nico@magicbroccoli.de>
Date: Tue, 9 Jun 2020 17:52:27 +0200
Subject: fix version string being unpopulated

* fix version string being empty
+ add error code 17 to the README
resolves #2

Error Code 17 means one of two things
a) the configured user credentials are not correct, therefore the user is not able to properly login
b) the configured user does not have the correct permissions to interact with the api
---
 README.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 2e956d2..fd4f4e1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,9 @@
-# ejabberd-metrics
+## ejabberd-tools
 
+### error codes
+Lookup table for all custom error codes.
+The potential reasons are sorted by probability of being the root cause.
+
+| code | potential reason |
+| :---: | :---|
+| 17 | login credential mismatch, potential api permission problem |
-- 
cgit v1.2.3-18-g5258