From 4f5d6b46badad209f220e14fd5d6d99f82134c3d Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Sat, 14 Nov 2020 22:51:46 +0200
Subject: [PATCH] Document usage.

On host01.shore.co.il or different hosts.
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 32ef9c0..33c8131 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,20 @@ other Docker containers for jobs. This image registers with the server on
 startup and has the `docker` package already installed (it needs to have the
 dockerd socket mounted inside the container).
 
+## Usage
+
+First of all, get the registration token from
+https://git.shore.co.il/admin/runners. To build and run on `host01.shore.co.il`,
+just run:
+```
+docker-compose build && REGISTRATION_TOKEN='INSERT_TOKEN' docker-compose up -d
+```
+
+If you want to run on a different host (for example `ns4.shore.co.il`), run:
+```
+DOCKER_HOST=ssh://ns4.shore.co.il docker-compose build && DOCKER_HOST=ssh://ns4.shore.co.il REGISTRATION_TOKEN='INSERT_TOKEN' RUNNER_NAME=ns4.shore.co.il docker-compose up -d
+```
+
 ## License
 
 This software is licensed under the MIT license (see `LICENSE.txt`).
-- 
GitLab