From 5e9aa837691e2e69bf586e3d49efab3f1bf1508f Mon Sep 17 00:00:00 2001
From: ben <ben@noreply.gitdab.com>
Date: Sun, 12 Jan 2020 07:39:45 +0000
Subject: [PATCH] Add 'README.md'

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a8f168
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Speedtest Logger
+### What is it?
+This sccript runs an [internet speed test](https://speedtest.net/) at a certain interval, and saves the results to a file.
+
+### Setup:
+
+1. Clone this repo<br>`git clone https://gitdab.com/ben/speedtest.git`
+2. Install the dependencies<br>`npm install`
+3. Compile<br>`npx tsc`
+4. Create a blank `xlsx` file
+5. Set the interval and path in `dist/index.js`
+6. Start the script*<br>`node dist/index.js`
+
+
+\* I reccomend using something similar to [PM2](https://pm2.keymetrics.io/) to ensure the script is always running
\ No newline at end of file