From e98fdb67816ef1273731b535c3934a40f207a23c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Gramain?= <mael@enpls.org>
Date: Tue, 21 Mar 2023 16:29:40 +0100
Subject: [PATCH] Add Readme

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d6b57d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# EnPLS EPEE Service
+
+This service serves as an error and debug service for the EnPLS Proxy infrastructure called EPEE for _Enpls Proxy EnginE_. This service is based on Traefik instances. 
+
+EPEE Service provides : 
+- Error pages (Upstream error and not found page) on ``/error.html``
+- Static file serving as Traefik is unable to do that 
+- Debug utility at the ``/trace`` URL 
+
+All of theses URL is prefixed by ``/cdn-cgi/`` and should be configured to be present on all proxied domain by Traefik. 
+