From 5a81831ae50708ab8d9665e5a824f2c72eca1085 Mon Sep 17 00:00:00 2001
From: Derek-K <Derek-K@users.noreply.github.com>
Date: Tue, 9 Jun 2020 01:47:38 -0400
Subject: [PATCH] README

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b52b96
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# telegraf-speedtest
+Using official SpeedTest.net cli for telegraf
+
+Tested with Ubuntu 18.04.4 LTS, Telegraf 1.14.1
+
+HOWTO:
+1) Install the official SpeedTest CLI from SpeedTest.net - https://www.speedtest.net/apps/cli
+2) Run 'speedtest' once (to accept the license)
+3) Add the configuration into telegraf, either
+   - store speedtest.conf under /etc/telegraf.d
+    * OR *
+   - copy the config and add to your telegraf.conf
+4) Restart telegraf (e.g. under Ubuntu "sudo systemctl restart telegraf")
+
+Optionally, install Grafana dashboard #12428
+  https://grafana.com/grafana/dashboards/12428
+  
+Enjoy!
+p.s. Do not set the interval too short or you may get banned...
-- 
GitLab