write readme

Readme.md

@@ -0,0 +1,36 @@
+# Консольная панель управления серверами Minecraft.
+На самом деле можно приспособить под любые программы/сервера.
+
+## Авторство Артем Шкилев
+За основу была взята простая идея с какого-то форума и потом много раз доработана в процессе эксплуатации в течение 3 лет на продакшен среде.
+
+## Поддержка
+Более не поддерживается, разрешается использование как угодно, в том числе коммерчески, с указанием авторства.
+
+## Как использовать
+Файл mc-cp положить в /usr/local/bin и далее использовать как команду mc-cp. Остальные файлы не нужны, они для примера просто. У панели есть справка mc-cp help.
+
+## Возможности
+- Создание конфига под сервер - указание памяти, пути, короткого имени (все командой, не вручную)
+- Запуск сервера - без автоматического поднятия при падение, одноразовый запуск, с получением консоли приложения
+- Старт сервера - запуск сервера в отдельном консольном потоке, авто-поднятие при падение приложения, доступ в консоль в любой момент.
+- Отправка команды - можно отправить на ввод в консоль приложения любой текст, как если бы просто писался в консоли приложения.
+- Список созданных серверов - отображает список серверов, их статус (запущен/остановлен), есть ли права на него у текущего пользователя (права на основе прав на файл конфигурации, кто создал сервер, у того и полные права)
+- Доступ в консоль - открыть консоль в текущий экран, просто открывает консоль, выйти можно как из обычного screen
+
+## Полный текст HELP:
+
+========= Minecraft Server Control Panel (mc-cp) =========
+mc-cp NAME start - start NAME server
+mc-cp NAME stop - stop NAME server
+mc-cp NAME restart - send server NAME comand stop and after run
+mc-cp NAME send COMAND - send server NAME comand - COMAND
+mc-cp list - list all register servers,status & permissions current user SSH
+mc-cp NAME new-config - start master create new server with NAME
+mc-cp NAME view-config - show all config file NAME server
+mc-cp NAME remove-config - stop NAME server and remove his config
+mc-cp NAME console - open console screen select server NAME
+mc-cp NAME run - start server NAME with not auto run after down
+============== by Misterzym for up-world.ru =============
+
+