1 files changed, 19 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9e90f50
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+# speedtest logger
+
+This is basically just speedtest-cli --csv running indefinetly
+
+## CSV layout
+
+The current CSV headers are:
+
+Server ID,Sponsor,Server Name,Timestamp,Distance,Ping,Download,Upload,Share,IP Address
+
+To get just the download speeds in Mbps you can do:
+
+tail -n +2 log.txt | cut -f7 | numfmt --to-unit=M
+
+and similarly with -f8 for upload speeds
+
+## Ploting
+
+I've added a gnuplot script to generate these as a plot straight from the raw log file
\ No newline at end of file