diff --git a/README.md b/README.md index 3d18e0e80250fffec6b9e65aa94432007364f9fc..3b788894f4c83f3907ee72f9be1bca0582d586ca 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 + +