From c1a66bb91c3a1b375804ee040750d3306b720a25 Mon Sep 17 00:00:00 2001
From: Jack Greyhat <jack.greyhat@wearethedark.net>
Date: Thu, 28 Jan 2021 12:05:54 +0100
Subject: [PATCH] begin readme

---
 README.md | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 415a98f..503fd3d 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
 # LibreNMS Speedtest
 A Speedtest plugin for LibreNMS, built with RRD and Speedtest CLI by Ookla
 
-Instruction
------------
-blabla
+Introduction
+------------
+This is a plugin that enables internet uplink bandwidth graphing in a LibreNMS dashboard. It uses Ookla servers to perform the speedtest by calling Ookla's Speedtest CLI application. Data is stored in the backend into RRD and is visualized by using a LibreNMS style dashboard.
+Installation should be pretty straight forward.
+Screenshot:
+<img src="https://gitlab.com/jackgreyhat/librenms-speedtest/-/blob/master/images/dashboard-screenshot.png" width="800" height="400"/>
+