From 9517baba2404aef980b92c0201f77e3daf5a0f86 Mon Sep 17 00:00:00 2001
From: Baptiste Gelez <baptiste@gelez.xyz>
Date: Sat, 20 Apr 2019 14:44:55 +0100
Subject: [PATCH] A bit more complete readme

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3afcde4..407b600 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # Plume CI
 
-Experimental script to automatically deploy test instance for each proposed PR.
\ No newline at end of file
+Experimental script to automatically deploy test instance for each proposed PR.
+
+To execute:
+
+```
+sudo docker pull plumeorg/plume-buildenv:v0.0.5 # First time only
+sudo ./bash.sh
+```
+
+## How does it work?
+
+- The sqlite build is uploaded to the joinplu.me server for each new PR (by Circle CI)
+- This script waits for new uploads.
+- When a new build is uploaded, this script starts a Docker container that runs it
+- A Caddyfile is generated to make the test instances accessible from the outside
\ No newline at end of file