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
`git clone https://gitdab.com/ben/speedtest.git` +2. Install the dependencies
`npm install` +3. Compile
`npx tsc` +4. Create a blank `xlsx` file +5. Set the interval and path in `dist/index.js` +6. Start the script*
`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