From 376f82b834025997f85dc9578d8d883db1a65628 Mon Sep 17 00:00:00 2001
From: Andreas Neue <an@dnix.de>
Date: Tue, 20 Sep 2022 18:44:01 +0200
Subject: [PATCH] README.md

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/README.md b/README.md
index e69de29..188a4cd 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,48 @@
+# make-deploy
+
+A simple Makefile based deployment system.
+
+## Installation
+
+Clone make-deploy as a submodule into your repository:
+
+    $ git submodule add https://git.dnix.de/an/make-deploy
+    
+Create a symlink to the Makefile:
+
+	$ ln -s make-deploy/Makefile .
+	
+Create `config.mk` (for common config options) and `secrets.mk` (for sensitive information, should be git-crypted) in your project.
+
+Example `config.mk`:
+
+    DEPLOY_NAME = my-project
+	DEPLOY_PATH = /srv
+	DEPLOY_TYPE = compose
+	DEPLOY_HOSTS = server01.example.com server02.example.com
+
+	DOCKER_IMAGE = dr.example.com/my-project:latest
+	DOCKER_LOGIN = 1
+	DOCKER_REGISTRY = dr.example.com
+
+	SSH_USER = ci
+
+Example `secrets.mk`:
+
+    DOCKER_USER = root
+    DOCKER_PASS = secret1234
+
+## Usage
+
+### Available options for DEPLOY_TYPE
+
+compose, swarm, k8s (TBD), helm (TBD), cron (TBD)
+
+### Start the deployment process
+
+    make deploy
+    
+### Create docker contexts for the target hosts
+
+    make create-docker-contexts
+