From 80201149084bc319129cd593512726276786dfa1 Mon Sep 17 00:00:00 2001 From: Maxallica Date: Tue, 10 Mar 2026 19:43:38 +0100 Subject: [PATCH] Optimized documentation --- README.md | 20 +++++++++++++------- compose.yml | 5 +++-- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 33a4c2a..5a1e19f 100644 --- a/README.md +++ b/README.md @@ -60,11 +60,10 @@ You can: # Docker Support -The repository includes: - +This repository includes: - Dockerfile.sh — multi‑stage build for Go + Alpine - entrypoint.sh — generates config.json dynamically using environment variables -- docker-compose.yml — ready to run the viewer with one command +- compose.yml — ready to run the viewer with one command This allows you to run TS6 Viewer fully containerized. @@ -114,17 +113,24 @@ Environment variables include: This makes the Docker container fully configurable without editing files. -# docker-compose.yml +# compose.yml -A ready‑to‑use compose file is included in the project. -You can start the viewer with: +The `compose.yml` file provides a straightforward example of how to configure and run the ts6viewer using Docker. It also shows how to switch between a locally built image and the official Docker Hub image: ``` -docker compose up -d +# Use this if you built the image locally via: +# docker build -t ts6viewer:main . +# image: ts6viewer:main +# Use this if you want to pull the prebuilt image from Docker Hub +image: maxallica/ts6-viewer:latest ``` +You can find the prebuilt Docker image here +[![Docker Pulls](https://img.shields.io/docker/pulls/maxallica/ts6-viewer.svg?logo=docker&label=pulls)](https://hub.docker.com/r/maxallica/ts6-viewer) + --- + # Building the Program The project is written in Go. diff --git a/compose.yml b/compose.yml index d5b2e6f..9ecd62e 100644 --- a/compose.yml +++ b/compose.yml @@ -2,9 +2,10 @@ version: "3.9" services: ts6viewer: - # Use this if you built the image locally yourself + # Use this if you built the image locally via: + # docker build -t ts6viewer:main . # image: ts6viewer:main - # Use this if you want to pull the image via Docker Hub + # Use this if you want to pull the prebuilt image from Docker Hub image: maxallica/ts6-viewer:latest container_name: ts6viewer ports: