From e95e60f028430eaec10f95ba595aabc5de7fd483 Mon Sep 17 00:00:00 2001
From: Joseph Hale <me@jhale.dev>
Date: Tue, 17 Feb 2026 15:34:38 -0700
Subject: [PATCH] Update README with Docker Hub image and inline docker-compose
 example

- Add badges for Docker pulls, license, and social links
- Update image size from ~25MB to ~35MB (more accurate)
- Add inline docker-compose.yml example instead of referencing file
- Point to thehale/speedtest Docker Hub image
- Add Available Images section documenting Docker Hub and GHCR
- Rename Building section to Building from Source
---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 44 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index cacc1ff..48e0277 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,42 @@
 # Speedtest Docker
 
-A lightweight Docker container (~25MB) that runs [Ookla Speedtest](https://www.speedtest.net/apps/cli) on a configurable cron schedule and serves interactive graphs via http.
+A lightweight Docker container (~35MB) that runs [Ookla Speedtest](https://www.speedtest.net/apps/cli) on a configurable cron schedule and serves interactive graphs via http.
+
+[![](https://badgen.net/docker/pulls/thehale/speedtest)](https://hub.docker.com/r/thehale/speedtest)
+[![](https://badgen.net/github/license/thehale/speedtest)](https://github.com/thehale/speedtest/blob/master/LICENSE)
+[![](https://badgen.net/badge/icon/Sponsor/pink?icon=github&label)](https://github.com/sponsors/thehale)
+[![Joseph Hale's software engineering blog](https://jhale.dev/badges/website.svg)](https://jhale.dev)
+[![](https://jhale.dev/badges/follow.svg)](https://www.linkedin.com/comm/mynetwork/discovery-see-all?usecase=PEOPLE_FOLLOWS&followMember=thehale)
+
 
 ## Quick Start
 
 ### Using Docker Compose
 
-1. Copy the example environment file:
-   ```bash
-   cp .env.example .env
-   ```
+Create a `docker-compose.yml` file:
+
+```yaml
+services:
+  speedtest:
+    image: thehale/speedtest:latest
+    container_name: speedtest
+    ports:
+      - "8080:8080"
+    volumes:
+      - ./data:/data
+    environment:
+      - CRON_SCHEDULE=0 */5 * * *
+      - HOME=/tmp
+    restart: unless-stopped
+```
 
-2. Start the container:
-   ```bash
-   docker-compose up -d
-   ```
+Then run:
+
+```bash
+docker-compose up --detach
+```
 
-3. Access the dashboard at http://localhost:8080
+Access the dashboard at http://localhost:8080
 
 ### Using Docker Run
 
@@ -26,8 +46,9 @@ docker run -d \
   -p 8080:8080 \
   -v $(pwd)/data:/data \
   -e CRON_SCHEDULE="0 */5 * * *" \
+  -e HOME=/tmp \
   --restart unless-stopped \
-  speedtest
+  thehale/speedtest:latest
 ```
 
 ## Configuration
@@ -53,7 +74,18 @@ The CSV file containing all speedtest results is stored at `/data/speedtest.csv`
 -v /path/to/data:/data
 ```
 
-## Building
+## Available Images
+
+Images are published to both Docker Hub and GitHub Container Registry:
+
+- **Docker Hub**: `docker.io/thehale/speedtest`
+- **GitHub**: `ghcr.io/thehale/speedtest`
+
+Available tags:
+- `latest` - Most recent stable release
+- `v1.0.0`, `v1.1.0`, etc. - Specific version tags
+
+## Building from Source
 
 ```bash
 docker build -t speedtest .
-- 
2.51.2