Improve README's

Author: AFCMS

.github/README_ARTIFACTHUB.md

@@ -0,0 +1,35 @@
+# Fluorite
+
+An elegant, offline‑first Progressive Web App (PWA) video player. This container image serves the built static application using Caddy.
+
+## Features
+
+- Drag & Drop or file dialog to open a video
+- Clean controls with auto‑hide and keyboard shortcuts
+- Video info overlay (codec, bitrate, dimensions, etc.)
+- PWA: installable, offline‑ready with a service worker
+- Internationalization (currently English and French)
+- Privacy‑friendly: no backend, no telemetry
+
+## Docker Image
+
+- Preconfigured Caddy server serving static files from /srv
+- Hardened HTTP security headers
+- No volumes or env vars required
+- No TLS support (reverse proxy required for production use)
+- Expose port 80 in the container
+
+Pull and run the image:
+
+```bash
+docker pull ghcr.io/afcms/fluorite:master
+docker run --rm -p 4173:80 ghcr.io/afcms/fluorite:master
+# Open http://localhost:4173
+```
+
+Or build locally:
+
+```bash
+docker build -t fluorite:latest .
+docker run --rm -p 4173:80 fluorite:latest
+```

Dockerfile

@@ -9,7 +9,7 @@ LABEL org.opencontainers.image.authors="AFCMS <afcm.contact@gmail.com>"
 LABEL org.opencontainers.image.licenses="GPL-3.0-only"
 LABEL org.opencontainers.image.source="https://github.com/AFCMS/fluorite"
 LABEL io.artifacthub.package.logo-url="https://raw.githubusercontent.com/AFCMS/fluorite/refs/heads/master/public/fluorite.svg"
-LABEL io.artifacthub.package.readme-url="https://raw.githubusercontent.com/AFCMS/fluorite/refs/heads/master/README.md"
+LABEL io.artifacthub.package.readme-url="https://raw.githubusercontent.com/AFCMS/fluorite/refs/heads/master/.github/README_ARTIFACTHUB.md"
 LABEL io.artifacthub.package.category="skip-prediction"
 LABEL io.artifacthub.package.keywords="video-player,offline,pwa"
 LABEL io.artifacthub.package.license="GPL-3.0-only"

README.md

@@ -1,15 +1,81 @@
+<img align="right" width="100" height="100" src="public/fluorite.svg">
+
 # Fluorite
 
-A elegant PWA video player.
+An elegant, offline‑first PWA video player for your local media. Try the [official version](https://fluorite.afcms.dev)!
 
 ![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)
 ![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
 ![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
 ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
 
-```shell
+## Features
+
+- Drag & Drop or file dialog to open a video
+- Clean controls with auto‑hide and keyboard shortcuts
+- Video info overlay (codec, bitrate, dimensions, etc.)
+- PWA: installable, offline‑ready with a service worker
+- Internationalization (currently English and French)
+- Privacy‑friendly: no server, no tracking; plays your local files in the browser
+
+## Quick start (local)
+
+This project requires pnpm.
+
+```bash
+corepack enable pnpm
 pnpm install
+
+# Development (http://localhost:5173)
 pnpm run dev
-# or
+
+# Production build + preview (http://localhost:4173)
 pnpm run build && pnpm run preview
 ```
+
+## Run with Docker
+
+Prebuilt images are published to GitHub Container Registry.
+
+Pull and run:
+
+```bash
+docker pull ghcr.io/afcms/fluorite:master
+docker run --rm -p 4173:80 ghcr.io/afcms/fluorite:master
+# Open http://localhost:4173
+```
+
+Build locally and run:
+
+```bash
+docker build -t fluorite:latest .
+docker run --rm -p 4173:80 fluorite:latest
+# Open http://localhost:4173
+```
+
+Docker details:
+
+- Preconfigured Caddy server serving static files from /srv
+- Hardened HTTP security headers
+- No volumes or env vars required
+- No TLS support (reverse proxy required for production use)
+
+## Internationalization
+
+Fluorite uses Lingui for i18n.
+
+```bash
+pnpm run extract    # extract source strings
+# edit translations in src/locales/*/messages.po
+pnpm run build
+```
+
+## Development
+
+Scripts of interest:
+
+- `pnpm run dev` — start dev server at http://localhost:5173
+- `pnpm run build` — typecheck and build the app
+- `pnpm run preview` — preview the production build at http://localhost:4173
+- `pnpm run lint` — run ESLint
+- `pnpm run test` — run unit tests (Vitest)