Added more info to readme

.travis.yml

@@ -25,7 +25,7 @@ deploy:
   provider: releases
   api_key:
     secure: MXwS0TBvuGM+VahPTYrxmdJY/K2EyIOikDr/Z9yMcdI2yui7Y6T659X0Vm2Tv2/ntcBNuuBd67IeTuDToY47/VduhPdfnfpQ/4xtBkLQhoXNm2wlmWHHA7T1ISFdcxkj9QceyKvqqlnd2mSftDTZ6Htt1paKX8JhLnJDDce2VTFasXkUiHTqaq5xhx8sE5nkY5//fa6mAIElUQCTumM7+BHSWXj+AgqCXeLlysa0S9SyrHBR4NbFq8mnlK0N1QgXOug9j9NoLug5EDfKcoIg6zdG/oa7rIAAEIcDaA4VSGujG98CHcIGwbTjHJ7XNUK7sPoO03cxDe+HiRUBg3G92vcXFX0z8NhoxbFtkWZKtlrf+g77kiI51pNjZl4Bew/+BiFxbsH6zqSFgXoCNBGee+Fl9uXsj/QEeMrwY5CcxclaKLsitV6oitf2PnaPD0xmjndw//MOrA19JsMUrBc8zSpkUH0yUoU76ZT3KCPaFMXpdZQBtskFpjgSq9ILVOq9sUuVtAmt7ftIf9OcFvSZfejauJTgaLapVMH4HQWrDkna9EFoKi0pjubo38CGDaDOlXQJU3unkgjN4JOn2wqAWxcn9hMVCUM+yLY5fjDAGxX6HUvzaJwCRKgsx45UwvEotHwlVMACCz98WXqQKY0pqHuSTuVRFqKA0Pdre3xOjLM=
-  file: addons/sourcemod/scripting/compiled/ts-mover.smx
+  file: compiled/ts-mover.smx
   on:
     repo: FrederikP/csgo-ts-mover
     tags: true

README.md

@@ -1,2 +1,30 @@
 # csgo-ts-mover
 Moves players to teamspeak channels according to the team they are on. Especially fun for retake and similar game modes.
+
+## Overview
+The provided functionality is realized using two components. The first component is a sourcemod plugin. This plugin is only responsible for communicating team changes. The other component is a web service that talks with the teamspeak server and reacts to the change information received by the sourcemod plugin.
+
+## Setup
+
+### Requirements
+
+- Sourcemod (https://www.sourcemod.net/downloads.php)
+- RipExt (https://github.com/ErikMinekus/sm-ripext)
+- Python3 (with the following libraries: flask, ts3)
+- Teamspeak with Query Login Credentials
+
+### Starting the service
+
+- put ts-mover.smx (see Releases) into the plugins folder of your sourcemod installation
+- customize your configuration
+  - the mapping maps steamid -> teamspeak nickname
+  - channel names take care of where players are put
+  - lobby threshold determines the minimum number to swap players into the t and ct channels
+- start the service (config file should be in the same folder):
+
+```
+FLASK_APP=ts-mover-service.py
+flask run --port 6666
+```
+
+Use screen, or docker, or whatever to keep it running.