diff --git a/README.md b/README.md index 4239169..f036665 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Speedtest_logger -A basic script that uses Speedtest-cli and logs the result to a csv file -
/br> +A basic script that uses Speedtest-cli and logs the result to a csv file and to a Discord Webhook +

### How to Create a Discord Web Hook 1) On your Discord server, right click on the text channel that you want the results to appear in and then select "Edit Channel". @@ -15,3 +15,6 @@ A basic script that uses Speedtest-cli and logs the result to a csv file 1) Open the Speedtest.sh or .bat file (depending if you are using the Linux verison or the Windows version) and replace the "DISCORD_WEBHOOK_URL" with the coppied Webhook URL. 2) Change the WAN "NUMBER" option, this is handy if you have multiple connections to test. +### Running the Script + +Once and dependancys have been installed (this will be noted in each versions README file) the script can be ran. This will run the speedtest-cli software and save the output speeds to a variable which will then be "posted" via curl to the Discord Webhook. The script can be ran manually or on a scheduled (this should be the prefered option). \ No newline at end of file