Add README.md

README.md

@@ -0,0 +1,52 @@
+# multi-ssh
+
+An application to upload a file or perform a command on multiple servers via ssh and scp. 
+
+## Configuration
+
+Set the environment variable `MSSH_SERVERS` to configure the server directories of your ssh servers
+
+### Linux example
+
+```bash
+export MSSH_SERVERS="crea:server/creative2,sky:sky,city:city2"
+```
+
+## Usage
+
+For detailed usage please see:
+```bash
+multi-ssh --help
+```
+
+### Command example
+
+Delete the WorldGuard folder on crea, sky and city:
+```bash
+multi-ssh crea sky city -c "rm -r plugins/WorldGuard" 
+```
+
+### Upload example
+
+Upload a new version of the MenuApi plugin and delete old versions from the servers:
+```bash
+multi-ssh crea sky city minez lobby -u target/MenuApi-3.4.2.jar 
+```
+
+Upload a new version of the MineZ plugin but keep backups of the older versions:
+```bash
+multi-ssh minez -u target/MineZ-3.0.jar -a 
+```
+
+The program will show you an overview of what it will be doing before actually performing any of the actions:
+```
+minez:
+* renaming MineZ-2.7.jar -> MineZ-2.7.jarr
++ adding MineZ-3.0.jar
+Continue [Y|n]: 
+```
+
+For detailed usage of the upload feature see
+```bash
+multi-ssh -u --help
+```