From 47c42f8b5500ede66fbc203b840eaa286cc94f5a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A1n=20Robotka?= <robotka.adrian@gmail.com>
Date: Thu, 9 Jul 2020 20:56:06 +0200
Subject: [PATCH] add usage to readme

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

diff --git a/README.md b/README.md
index 2070893..c180b14 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,21 @@
 The original SSH executor can only be used for a single/static host described
 in the runner config. This is not as flexible as our use-case's needs.
 
-# Install
+# Usage of the executor
+```yaml
+deploy:
+  stage: your deploy stage
+  tags: [kszk-deploy] # request the custom SSH executor
+  script: # your deploy logic
+    - cd /deploy
+    - docker-compose pull and run and everything
+  variables:
+    SSH_HOST: donald.sch.bme.hu     # required
+    SSH_USER: kszk-gitlab-deployer  # default: kszk-gitlab-deployer
+    SSH_PORT: 10122                 # default: 22
+```
+
+# Install the executor
 ```sh
 cd /opt
 git clone git@git.sch.bme.hu:kszk/opensource/ssh-executor.git ssh-executor
-- 
GitLab