updated readme

readme.md

@@ -0,0 +1,45 @@
+# Installing the Project
+
+```
+cd /opt  
+sudo git clone https://gitlab.com/Snogard/kaido
+chmod 777 /opt/kaido
+```
+Then in your .zshrc or .bashrc
+```
+alias kaido="/opt/kaido/kaido.sh
+```
+
+# Configuration
+
+### /etc/kaido/update.conf
+this file contains the definitions of what must be installed/configured/built when using the "kaido update" command
+
+example file
+
+```
+install-youtubedl
+configure-reverse-proxy-server
+build-mongodb
+```
+
+regardless of the order in the file, the execution is in this order:
+
+1. build
+1. install
+2. configure
+
+###
+
+# How To
+
+## gitlab-runner
+
+first time:
+```
+kaido install gitlab-runner register "insert_token_here"
+```
+other times: 
+```
+kaido install gitlab-runner
+```