[Documentation] Updated docs for v1 (#1914)

README.md

@@ -1,76 +1,23 @@
 # 🐇 Speedtest Tracker
 
-Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtests using Ookla's Speedtest service.
+Speedtest Tracker is a self-hosted application that monitors the performance and uptime of your internet connection.
 
-[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date)
+![Dashboard](.github/screenshots/dashboard.jpeg)
 
-### Why might I use this?
+## Features
 
-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.
+- **Automated Tests**: Schedule regular speed tests to monitor your internet connection's performance over time.
-
+- **Detailed Metrics**: Capture download and upload speeds, ping, packet loss and more.
-### What about that other Speedtest Tracker?
+- **Historical Data**: View historical data and trends to identify patterns and issues with your internet connection.
-
+- **Notifications**: Receive notifications when your internet performance drops below a certain threshold.
-As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was abandoned. This is meant to be an actively maintained replacement with an improved UI and feature set.
 
 ## 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).
+Speedtest Tracker is containerized so you can run it anywhere you run your containers. The image is built by LinuxServer.io, build information can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker).
 
-### Quick Start
+- [Installation](https://docs.speedtest-tracker.dev/getting-started/installation) guide will get you up and running and includes steps for deploying the Docker image or to NAS platforms like Synology and Unraid.
+- [Configurations](https://docs.speedtest-tracker.dev/getting-started/environment-variables) are used to tailor Speedtest Tracker to your needs.
+- [Notifications](https://docs.speedtest-tracker.dev/settings/notifications) channels alert you when issues happen.
+- [Frequently Asked Questions](https://docs.speedtest-tracker.dev/help/faqs) are common questions that can help you resolve issues.
 
-#### Docker
+[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date)
-
-```bash
-docker run -d --name speedtest-tracker --restart unless-stopped \
-    -p 8080:80 \
-    -e PUID=1000 \
-    -e PGID=1000 \
-    -e APP_KEY= \ # How to generate an app key: https://speedtest-tracker.dev/
-    # -e SPEEDTEST_SCHEDULE= \ # optional: schedule a speedtest with an cronjob https://crontab.guru
-    -e APP_URL=http://localhost \
-    -e DB_CONNECTION=sqlite \
-    -v ${PWD}:/config \
-    lscr.io/linuxserver/speedtest-tracker:latest
-```
-
-#### Docker Compose
-
-```bash
-services:
-    speedtest-tracker:
-        container_name: speedtest-tracker
-        ports:
-            - 8080:80
-            - 8443:443
-        environment:
-            - PUID=1000
-            - PGID=1000
-            - APP_KEY= # How to generate an app key: https://speedtest-tracker.dev/
-            - APP_URL=http://localhost
-            - DB_CONNECTION=sqlite
-            # - SPEEDTEST_SCHEDULE= # optional: schedule a speedtest with an cronjob https://crontab.guru
-        volumes:
-            - /path/to/data:/config
-            - /path/to-custom-ssl-keys:/config/keys
-        image: lscr.io/linuxserver/speedtest-tracker:latest
-        restart: unless-stopped
-```
-For more environment configuration to customize your installation see the docs: https://docs.speedtest-tracker.dev/getting-started/environment-variables
-
-
-## Image version
-
-A full list of released versions can be found here: https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker
-
-### 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).
-
-## API
-
-A robust API is planned for a later release but as of `v0.11.8` a legacy endpoint `/api/speedtest/latest` which is used by home lab dashboards like [Homepage](https://github.com/benphelps/homepage) and [Organizr](https://github.com/causefx/Organizr/tree/v2-master).
-
-## Screenshots
-
-![Dashboard](.github/screenshots/dashboard_screenshot.jpg)
-**Dashboard**

SECURITY.md

@@ -2,4 +2,6 @@
 
 ## Reporting a Vulnerability
 
-Found a security vulnerability? **DON'T open an issue**, report it to [sec@alexjustesen.com](mailto:sec@alexjustesen.com) so I can address it promptly.
+Found a security vulnerability?
+
+**DON'T open an issue**, report it to [sec@alexjustesen.com](mailto:sec@alexjustesen.com) so I can address it promptly.

🐇 Speedtest Tracker.postman_collection.json

@@ -1,62 +0,0 @@
-{
-	"info": {
-		"_postman_id": "cec84a4a-2422-4c13-bc49-3a2ee2729f62",
-		"name": "🐇 Speedtest Tracker",
-		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
-		"_exporter_id": "13492307"
-	},
-	"item": [
-		{
-			"name": "Speedtest (legacy)",
-			"item": [
-				{
-					"name": "Get latest",
-					"request": {
-						"method": "GET",
-						"header": [],
-						"url": {
-							"raw": "{{APP_URL}}/api/speedtest/latest",
-							"host": [
-								"{{APP_URL}}"
-							],
-							"path": [
-								"api",
-								"speedtest",
-								"latest"
-							]
-						}
-					},
-					"response": []
-				}
-			],
-			"description": "The `/speedtest` route is to provide legacy support for dashboards like Homepage and Organizr.\n\nThe endpoint should be considered deprecated and will be replaced in a future release."
-		}
-	],
-	"event": [
-		{
-			"listen": "prerequest",
-			"script": {
-				"type": "text/javascript",
-				"exec": [
-					""
-				]
-			}
-		},
-		{
-			"listen": "test",
-			"script": {
-				"type": "text/javascript",
-				"exec": [
-					""
-				]
-			}
-		}
-	],
-	"variable": [
-		{
-			"key": "APP_URL",
-			"value": "",
-			"type": "string"
-		}
-	]
-}