diff --git a/README.md b/README.md index cd1cd9334..5bd3fda9d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ ## Speedtest Tracker +### Introduction + Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service. ### Why might I use this? + The main use case for Speedtest Tracker is to build a history of your internet's performance so that you can be informed when you're not receiving your ISP's advertised rates. -### What about that other Speedtest Tracker? +#### What about that other Speedtest Tracker? + As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was abandoned. This version is meant to be an actively maintained replacement with an improved UI and feature set. -### Documentation and Features -The docs can be found here https://docs.speedtest-tracker.dev to help you get started and also contains a full list of features. +### Getting Started + +Speedtest Tracker is containerized so you can run it anywhere you run your Docker containers. The [install](https://docs.speedtest-tracker.dev/getting-started/installation) documentation will get you up and running with using Docker or Docker Composer along with choosing a database (SQLite, MySQL/MariaDB or Postgresql). + +#### FAQs and Features + +[FAQs](https://docs.speedtest-tracker.dev/faqs) and a full list of planned and completed [features](https://docs.speedtest-tracker.dev/getting-started/features) can be found in the [documentation](https://docs.speedtest-tracker.dev). ### Screenshots #### Dashboard diff --git a/config/speedtest.php b/config/speedtest.php index 821bf2d65..4bcf65475 100644 --- a/config/speedtest.php +++ b/config/speedtest.php @@ -6,7 +6,7 @@ /** * Build information */ - 'build_date' => Carbon::parse('2023-03-05'), + 'build_date' => Carbon::parse('2023-03-06'), - 'build_version' => '0.11.3', + 'build_version' => '0.11.4', ];