From 07cd022654086a4a917d1b5ae2669949532dbda5 Mon Sep 17 00:00:00 2001
From: David Beniamine <david.beniamine@tetras-libre.fr>
Date: Tue, 8 Nov 2022 12:50:08 +0100
Subject: [PATCH] Update documentation

---
 README.md | 37 ++++++++++++++++++++++++++-----------
 1 file changed, 26 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 0b30510..5aa6018 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,21 @@
 ## Mirador Video Annotation POC
 
+### What is this repository
+
+This is a [Mirador](https://projectmirador.org/) based application that provides video annotation edition features :
+
++ [x] Video rendering in mirador base on the work of [Tokyo university](https://github.com/2SC1815J/mirador)
++ [x] Annotation persistance using [annotot](https://github.com/PenguinParadigm/annotot)
++ [x] Manifest storage and persistance
++ [-] Annotation on video (currently only working on images) 
++ [ ] Multi user and per-user workspace
+
+### Requirements
+
++ [docker](https://docs.docker.com/)
++ [docker-compose](https://docs.docker.com/compose/install/)
+
+This readme assumes that you now a few basic about `docker` and `docker-compose`, if you are not familliar with `docker-compose` we recommand to read [the documentation](https://docs.docker.com/compose/) first.
 
 ### Install
 
@@ -8,22 +24,21 @@ Copy `.env.template` to `.env` and change variables to suit your need.
 
 The `$HTTP_FOLDER` (`./www` by default) directory will be accessible via HTTP at `http://localhost:$PORT/data` and can be used to store manifests and theirs ressources and see them in Mirador.  
 
+Run `docker-compose up -d`, which will serve a mirador instance at `http://localhost:$DEV_PORT` (default port is 9000) with live rebuild/reload enabled on each `src/` and `public/` files modifications.
+
+### Production
+
+For production, one **also** need to setup :
+
++ `COMPOSE_FILE` should be at least `docker-compose.yml`
+Run `docker-compose up -d`, which will serve a mirador instance at `http://localhost:$PORT` (default port is 8080).
+
 If sources files are modified, run `docker-compose up -d --build` to update Mirador  
 
 #### Traefik
 
-We provide a `traefik.yml` file to use behind [traefik](https://traefik.io/https://traefik.io/) this file does the following assumptions :
+We provide a `traefik.yml` file to use behind [traefik](https://traefik.io/) this file does the following assumptions :
 
 + A traefik container exists and is running in an external docker network called `traefik`
 + Traefik has a tls resolver called `myresolver`
 + Traefik has a middleware called `hardening@docker` that adds the usual security headers
-
-
-#### Developpement
-
-Follow the previous instructions if you want to access ressources from `$HTTP_FOLDER` via HTTP in the devserver.  
-
-Edit `.env` (copy it from `.env.template` if needed), set `COMPOSE_FILE=docker-compose.yml:devserver.yml` and adapt `DEV_*` variables to your needs.  
-
-Run `docker-compose up -d --build devserver`, which will serve a mirador instance at `http://localhost:$DEV_PORT` (default port is 9000) with live rebuild/reload enabled on each `src/` and `public/` files modifications.  
-
-- 
GitLab