diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 495ccbe81..5489438ef 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,29 +1,29 @@ -# Description +## 📃 Description A short description of the pull request changes should go here and the sections below should list in detail all changes. You can remove the sections you don't need. -## Changelog +## 🪵 Changelog -### Added +### ➕ Added - one - two -### Changed +### ✏️ Changed - one - two -### Fixed +### 🔧 Fixed - one - two -### Removed +### 🗑️ Removed - one - two -## Screenshots +## 📷 Screenshots If this PR has any UI/UX changes it's strongly suggested you add screenshots here. diff --git a/.github/screenshots/general_settings_screenshot.jpg b/.github/screenshots/general_settings_screenshot.jpg deleted file mode 100644 index 0f5dfdfa0..000000000 Binary files a/.github/screenshots/general_settings_screenshot.jpg and /dev/null differ diff --git a/.github/screenshots/login_screenshot.jpg b/.github/screenshots/login_screenshot.jpg deleted file mode 100644 index ba7b39227..000000000 Binary files a/.github/screenshots/login_screenshot.jpg and /dev/null differ diff --git a/.github/screenshots/results_screenshot.jpg b/.github/screenshots/results_screenshot.jpg deleted file mode 100644 index 2f8597456..000000000 Binary files a/.github/screenshots/results_screenshot.jpg and /dev/null differ diff --git a/README.md b/README.md index b243f7e9a..30c6af482 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Speedtest Tracker +[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date) + ## Introduction Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service. @@ -14,9 +16,19 @@ As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was aba ## 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 (MySQL/MariaDB or Postgresql). +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). -[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date) +### Quick Start + +```dockerfile +docker run -d --name speedtest-tracker --restart unless-stopped \ + -p 8080:80 \ + -e PUID=1000 \ + -e PGID=1000 \ + -e DB_CONNECTION=sqlite \ + -v /path/to/data:/config \ + lscr.io/linuxserver/speedtest-tracker:latest +``` ### FAQs and Features @@ -30,9 +42,3 @@ A robust API is planned for a later release but as of `v0.11.8` a legacy endpoin ![Dashboard](.github/screenshots/dashboard_screenshot.jpg) **Dashboard** - -![Results page](.github/screenshots/results_screenshot.jpg) -**Results page** - -![General Settings page](.github/screenshots/general_settings_screenshot.jpg) -**General Settings page**