Add doc for Wekan

README.md

@@ -86,6 +86,35 @@ Mattermost module exports following metrics :
 - `mattermost_daily_users` : Number of users that write a post on a day
 Each metric have a `name` tag with the name of the instance.
 
+### Wekan
+
+Wekan module collects several metrics from the [Wekan API](https://wekan.github.io/api/).
+
+#### Configuration
+
+To enable Wekan module, you need to add a `wekan` key to the `modules` object inside configuration JSON file. The value should be like this :
+```json
+  "wekan" : [
+    {
+      "url" : "https://my.wekan.tld",
+      "user" : "admin_username",
+      "password" : "admin_password",
+      "name" : "instancename"
+    }
+  ]
+```
+
+Pay attention that it is a **list** of objects (wich contains URL, credentials and name of your instance) in order to collect data from multiple Wekan instances.
+
+#### Metrics
+
+Mattermost module exports following metrics :
+- `wekan_total_users` : Number of users on the instance
+- `wekan_public_boards` : Number of public boards on the instance
+- `wekan_private_boards` : Number of private channels on the instance
+Each metric have a `name` tag with the name of the instance.
+
+
 ## Creating a module
 
 This bot can be easily extends by adding a module to gather metrics from a new service.