From 9d97498b2b7527dcdb20c13a76db401f52ee525a Mon Sep 17 00:00:00 2001
From: Stefano Alberto Russo <stefano.russo@gmail.com>
Date: Mon, 11 Oct 2021 23:42:46 +0200
Subject: [PATCH] Updated README.

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3d18e0e..3b78889 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,57 @@
 # ESAP
-ESAP repository for the ESCAPE project
+
+
+This is a repository for quickly having an instance of ESAP up & running. Batteries included.
+
+
+## Quickstart
+
+Requirements:
+    
+    Bash and Docker.
+
+
+Setup
+
+    $ esap/setup
+
+
+Build
+
+    $ esap/build
+
+
+Run
+
+    $ esap/run
+
+
+Play
+
+    https://localhost
+
+
+Clean
+
+    $ esap/clean
+
+
+### Extras
+
+List all running services
+
+    # esap/ps
+
+Open a shell in a service
+
+    # esap/shell api-gateway
+
+
+
+### Building errors
+
+It is common for the build process to fail with a "404 not found" error on an apt-get instrucions, as apt repositories often change their IP addresses. In such case, try:
+
+    $ esap/build nocache
+
+
-- 
GitLab