feat: add CI workflow for Docker image publishing to GHCR and update README with Docker volume creation instructions

Author: decoded-cipher

.github/workflows/ci.yml

@@ -27,3 +27,39 @@ jobs:
 
       - name: Build
         run: CGO_ENABLED=1 go build -o netmon ./cmd/netmon
+
+  publish:
+    name: Publish Docker image to GHCR
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=raw,value=latest
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -6,7 +6,6 @@ A lightweight, self-hosted network monitoring dashboard. Tracks latency, jitter,
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 [![Go](https://img.shields.io/badge/Go-1.21+-00ADD8?logo=go)](https://golang.org)
 
----
 
 ## Features
 
@@ -17,7 +16,6 @@ A lightweight, self-hosted network monitoring dashboard. Tracks latency, jitter,
 - **SQLite storage** — no database server; data persists in a single file
 - **Cross-platform** — runs on Linux (x86, ARM/Pi), macOS, Windows, and Docker
 
----
 
 ## Quick Start
 
@@ -29,6 +27,9 @@ docker run -d \
   --network host \
   -v netmon-data:/data \
   ghcr.io/decoded-cipher/netmon:latest
+
+# create the volume first if it doesn't exist
+docker volume create netmon-data
 ```
 
 Or with Docker Compose:
@@ -61,7 +62,6 @@ make docker     # build Docker image
 make docker-run # build + run Docker container
 ```
 
----
 
 ## Configuration
 
@@ -76,7 +76,6 @@ All defaults live in `internal/monitor/monitor.go → DefaultConfig()`. There is
 | Speed test size | `1 MB` | Payload size (kept small to avoid hogging the link) |
 | HTTP port | `:8080` | Dashboard address |
 
----
 
 ## Architecture
 
@@ -96,7 +95,6 @@ web/
 2. `speedWorker` downloads/uploads 1 MB to Cloudflare every 30 min — updates latest bandwidth values
 3. Dashboard polls `GET /api/data` every 30s and renders charts client-side
 
----
 
 ## Platforms
 
@@ -115,23 +113,10 @@ GOOS=linux GOARCH=arm64 CGO_ENABLED=1 CC=aarch64-linux-gnu-gcc \
   go build -o netmon ./cmd/netmon
 ```
 
----
 
 ## Requirements
 
 - **Go 1.21+** for building from source
 - **CGO enabled** (`CGO_ENABLED=1`) — required by the SQLite driver (`go-sqlite3`)
 - A C compiler (`gcc` / `musl-gcc` / `clang`) at build time; not needed at runtime
 - `ping` available in `PATH` at runtime (standard on all platforms)
-
----
-
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md).
-
----
-
-## License
-
-[MIT](LICENSE)