Skip to content

Commit 5b17328

Browse files
authored
[Chore] README.md and template updates (#1139)
1 parent 14293b5 commit 5b17328

File tree

5 files changed

+21
-15
lines changed

5 files changed

+21
-15
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
# Description
1+
## 📃 Description
22

33
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.
44

5-
## Changelog
5+
## 🪵 Changelog
66

7-
### Added
7+
### Added
88

99
- one
1010
- two
1111

12-
### Changed
12+
### ✏️ Changed
1313

1414
- one
1515
- two
1616

17-
### Fixed
17+
### 🔧 Fixed
1818

1919
- one
2020
- two
2121

22-
### Removed
22+
### 🗑️ Removed
2323

2424
- one
2525
- two
2626

27-
## Screenshots
27+
## 📷 Screenshots
2828

2929
If this PR has any UI/UX changes it's strongly suggested you add screenshots here.
-153 KB
Binary file not shown.
-81.9 KB
Binary file not shown.
-202 KB
Binary file not shown.

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Speedtest Tracker
22

3+
[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date)
4+
35
## Introduction
46

57
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
1416

1517
## Getting Started
1618

17-
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).
19+
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).
1820

19-
[![Star History Chart](https://api.star-history.com/svg?repos=alexjustesen/speedtest-tracker&type=Date)](https://star-history.com/#alexjustesen/speedtest-tracker&Date)
21+
### Quick Start
22+
23+
```dockerfile
24+
docker run -d --name speedtest-tracker --restart unless-stopped \
25+
-p 8080:80 \
26+
-e PUID=1000 \
27+
-e PGID=1000 \
28+
-e DB_CONNECTION=sqlite \
29+
-v /path/to/data:/config \
30+
lscr.io/linuxserver/speedtest-tracker:latest
31+
```
2032

2133
### FAQs and Features
2234

@@ -30,9 +42,3 @@ A robust API is planned for a later release but as of `v0.11.8` a legacy endpoin
3042

3143
![Dashboard](.github/screenshots/dashboard_screenshot.jpg)
3244
**Dashboard**
33-
34-
![Results page](.github/screenshots/results_screenshot.jpg)
35-
**Results page**
36-
37-
![General Settings page](.github/screenshots/general_settings_screenshot.jpg)
38-
**General Settings page**

0 commit comments

Comments
 (0)