From 299bc2f55fff6d33f3e0aa1b9e140b248ea7b146 Mon Sep 17 00:00:00 2001
From: Matthias Kretschmann <m@kretschmann.io>
Date: Sat, 19 Mar 2016 01:46:36 +0100
Subject: [PATCH] mention environment variables for deployment

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9e913d2..c5dfc1a 100644
--- a/README.md
+++ b/README.md
@@ -29,9 +29,18 @@ The following compiles css & js files only:
 gulp build
 ```
 
-## Continuous Delivery
+## Deployment: Continuous Delivery
 
 The site gets built & deployed automatically via Codeship under the following conditions:
 
 - every push builds the site
 - every push to the master branch initiates a live deployment
+
+The [deployment script](_ci/deploy.sh) requires the following environment variables to be set:
+
+| variable | description
+|--|--
+| `$DEPLOY_SRC` | source of CI build artifacts. On Codeship this is usually `~/src/github.com/ascribe/wp-theme/ascribe/`
+| `$DEPLOY_USER` | user for connecting to deploy server
+| `$DEPLOY_HOST` | hostname of deploy server
+| `$DEPLOY_PATH` | path to deploy into on deploy server, should be `PATH_ON_SERVER/wp-content/themes/`