From b6d2e533868934a3c837dc93e4478009fb9f02e1 Mon Sep 17 00:00:00 2001
From: Julian Simioni <julian@simioni.org>
Date: Tue, 15 Sep 2020 13:57:28 -0400
Subject: [PATCH] Clarify that `ln` command may require sudo

While other `pelias` commands should not be run with `sudo`, `sudo` will
generally be required to create a symbolic link in
`/usr/local/bin/pelias` as described in our quickstart script.

This change adds `sudo` to that command and clarifies that it's the only
part of the quickstart script that should use `sudo`.

Connects https://github.com/pelias/docker/issues/214
---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 17c9694b..35487f12 100644
--- a/README.md
+++ b/README.md
@@ -82,7 +82,8 @@ set -x
 git clone https://github.com/pelias/docker.git && cd docker
 
 # install pelias script
-ln -s "$(pwd)/pelias" /usr/local/bin/pelias
+# this is the _only_ setup command that should require `sudo`
+sudo ln -s "$(pwd)/pelias" /usr/local/bin/pelias
 
 # cd into the project directory
 cd projects/portland-metro