From 11a157c58aa088c95579071c62d1fad43711b884 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Milan=20P=C3=A4ssler?= <me@petabyteboy.de>
Date: Tue, 8 Mar 2016 20:07:20 +0100
Subject: [PATCH] readme: add linkinfos

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 424b63a..04bd923 100644
--- a/README.md
+++ b/README.md
@@ -86,7 +86,7 @@ property and optionally `url` and `config` properties. If no `url` is supplied
 
 ## nodeInfos (array, optional)
 
-This option allows to show client statistics depending on following case-sensitive parameters:
+This option allows to show node statistics depending on following case-sensitive parameters:
 
 - `name` caption of statistics segment in infobox
 - `href` absolute or relative URL to statistics image
@@ -137,6 +137,25 @@ Examples for `globalInfos` using Grafana server rendering:
       }
     ]
 
+## linkInfos (array, optional)
+
+This option allows to show link statistics depending on the following case-sensitive parameters:
+
+- `name` caption of statistics segment in infobox
+- `href` absolute or relative URL to statistics image
+- `thumbnail` absolute or relative URL to thumbnail image,
+  can be the same like `href`
+- `caption` is shown, if `thumbnail` is not present (no thumbnail in infobox)
+
+To insert the source or target node-id in either `href`, `thumbnail` or `caption`
+you can use the case-sensitive template strings `{SOURCE}` and `{TARGET}`.
+
+    "linkInfos": [
+      { "href": "stats/dashboard/db/links?var-source={SOURCE}&var-target={TARGET}",
+        "thumbnail": "stats/render/dashboard-solo/db/links?panelId=1&fullscreen&theme=light&width=800&height=600&var-source={SOURCE}&var-target={TARGET}"
+      }
+    ]
+
 ## siteNames (array, optional)
 
 In this array name definitions for site statistics and node info can be saved. This requires one object for each site code. This object must contain: