From e1a18ebaf1f1122c78ffea2ee7127030a942d85a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20PAILHAREY?= <rpailharey@grandlyon.com>
Date: Wed, 11 Aug 2021 15:10:02 +0000
Subject: [PATCH] doc: Updated README.md

---
 README.md | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a6da557..0f6ecf8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,29 @@
-# Backoffice - Server
+# Ecolyo Agent - Server
 
-Backoffice server of ecolyo app
+Ecolyo Agent is the backoffice for the Ecolyo app.
+
+This repository contains the backend part of this backoffice.
+
+# Features
+
+- Authentification using OAuth2
+
+- Connected admins can use an API to edit and save different sections of the newsletters that will be sent to Ecolyo users
+
+- Exposes a public route to get the sections of a specific or the last newsletter
+
+# How to setup :
+
+This backend should be deployed with the frontend from [this repo](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client) 
+
+However this backend can be run in standalone :
+
+- Clone the repository
+
+- Set a .env file at the root and add all variables declared in the [template.env](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server/-/blob/dev/template.env) file
+
+- (**Optionnal**) you can create new certificates by running `cd dev_certificates && ./generate-certificates.sh`
+
+- Run `docker-compose up -d`
+
+Once deployed, you can access to a Swagger documentation of the API on https://${HOSTNAME}/swagger/index.html
-- 
GitLab