From 226fc57c30288ba590d7e230251d9f72736c7471 Mon Sep 17 00:00:00 2001
From: Quentin Dufour <quentin@deuxfleurs.fr>
Date: Thu, 25 Nov 2021 10:22:50 +0100
Subject: [PATCH] Add doc for garage, rename example as instrumented

---
 README.md                                  | 18 ++++++++++++++++++
 {example => instrumented}/deploy_garage.sh |  0
 2 files changed, 18 insertions(+)
 rename {example => instrumented}/deploy_garage.sh (100%)

diff --git a/README.md b/README.md
index 7fd7a6e..ce00677 100644
--- a/README.md
+++ b/README.md
@@ -14,3 +14,21 @@ sudo python3 main.py run-all example/deploy_garage.sh
 sudo python3 main.py run dc1:dc1s1 garage -c /tmp/garage-testnet/dc1/dc1s1/garage.toml status
 sudo python3 main.py destroy
 ```
+
+## Instrumented daemons
+
+If you want to use the scripts provided in the `instrumented` folder,
+you must add to your path some tools
+
+### Garage (`deploy_garage.sh`)
+
+```bash
+# see versions on https://garagehq.deuxfleurs.fr/_releases.html
+export GRG_ARCH=x86_64-unknown-linux-musl
+export GRG_VERSION=v0.5.0
+
+sudo wget https://garagehq.deuxfleurs.fr/_releases/${GRG_VERSION}/${GRG_ARCH}/garage -O /usr/local/bin/garage
+sudo chmod +x /usr/local/bin/garage
+
+garage help
+```
diff --git a/example/deploy_garage.sh b/instrumented/deploy_garage.sh
similarity index 100%
rename from example/deploy_garage.sh
rename to instrumented/deploy_garage.sh