From fba5d3589e768a1d46fd7a45aed3a5dd753dc7fe Mon Sep 17 00:00:00 2001
From: TychoWerner <34608981+TychoWerner@users.noreply.github.com>
Date: Sun, 1 Sep 2019 22:30:45 +0200
Subject: [PATCH] Added a example for the Wireguard API

This still needs changes to make the sentences more fluid and better sentence structure.
I personally am not good with that but the example is there.

Hope this contributes and can be used.
---
 README.md | 28 +++++++++++++++++++++++-----
 1 file changed, 23 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index b7cae9e..9ebf9e6 100644
--- a/README.md
+++ b/README.md
@@ -467,14 +467,32 @@ With the use of the [Home Assistant RESTful][ha-rest] integration, one should
 be able to grab some interesting data from this add-on.
 
 Example:
-
+Set the port in the add-on settings; for example: 6789 and your IP of your Home Assistant instance; the hassio.local didn't work for me.
+Add a rest sensor:
 ```yaml
-sensor:
-  - platform: rest
-    resource: http://a0d7b954-wireguard
+platform: rest
+name: wireguard_sensor
+resource: http://192.168.3.72:6789/
+value_template: 'TEST'
+json_attributes:
+  - ipad
+  - mac
+  - telefoon
 ```
+The value_template: 'TEST' is for having a state; if you don't do this you will reach the 255 characters state limit.
+For each peers add a json_attributes entry.
+For each peer you will get a attribute such as: 
+```json { "endpoint": "172.30.32.1:47004", "latest_handshake": 0, "transfer_rx": 48699004, "transfer_tx": 625289972 }```
 
-At this moment, we do not have template or examples on how this could be
+Having bytes isn't so useful; that's why we can change it with filesizeformat and a template:
+platform: template
+sensors:
+  ipad_sent:
+  value_template: '{{ states.sensor.wireguard_sensor.attributes["ipad"]["transfer_tx"] |filesizeformat}}'
+Check the end result:
+![Example picture](https://i.imgur.com/tRINGjC.png)
+
+At this moment, we have only a few templates or examples on how this could be
 used effectively with Home Assistant.
 If you have, sharing would be appreciated!