docs: add run instructions in README

2025-11-26 10:35:00 +00:00
parent a2b2bb3b2f
commit 1f6b0b5ac8
1 changed files with 25 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
 ![Docker build pipeline badge](https://git.lucaasmth.me/lucas.mathieu/flingue-website/actions/workflows/docker-build.yml/badge.svg)
+
+# Flingue Website
+
+## Description
+
+Small static website served by an Nginx container.
+
+## How to run
+
+### With docker run
+
+```bash
+docker run -p 8080:80 git.lucaasmth.me/lucas.mathieu/flingue-website:latest
+```
+
+### With docker compose
+
+```yaml
+services:
+  flingue-website:
+    image: git.lucaasmth.me/lucas.mathieu/flingue-website:latest
+    ports:
+      - 8080:80
+```
+