From 25a33101b1f6c08d9c36871bd0796114e438d704 Mon Sep 17 00:00:00 2001
From: Inga Lovinde <52715130+inga-lovinde@users.noreply.github.com>
Date: Fri, 7 Apr 2017 12:38:36 +0300
Subject: [PATCH] Readme updated

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

diff --git a/README.md b/README.md
index 71b49d4..8fefa96 100644
--- a/README.md
+++ b/README.md
@@ -46,3 +46,49 @@ git pull origin master
 npm test
 npm run build
 ```
+
+Использование
+=============
+
+В настройках нужного репозитория (и его форков) указать адрес хука: `https://micro-build-server/github/postreceive`.
+
+Добавить в корневую папку репозитория файл `mbs.pos` с содержимым следующего вида:
+
+```
+{
+	"type": "sequential",
+	"params": {
+		"tasks": [
+			{
+				"type": "dotnetbuild",
+				"params": {
+					"solution": "Legacy.Processing.Common.sln",
+					"forceCodeAnalysis": "true"
+				}
+			},
+			{
+				"type": "dotnetnugetprocess",
+				"params": {
+					"masterRepoOwner": "Legacy",
+					"nuspecName": "Legacy.Processing.Common",
+					"major": "4"
+				}
+			}
+		]
+	}
+}
+```
+
+Со списком возможных типов задач и их параметров можно ознакомиться в папке `BuildServer\lib\tasks`.
+
+Для добавления новой задачи достаточно добавить новый файл `yourtaskname.ts` в эту папку.
+
+Для получения информации о статусе сборки достаточно добавить в README.md нужного репозитория строчку
+
+```
+![Status](https://micro.build.server/status.svg)
+```
+
+Или вручную перейти на страницу с отчётом о сборке - для этого надо поменять в адресной строке адрес `https://github.enterprise/what/ever` на `https://micro.build.server/github.enterprise/what/ever`.
+
+В обоих случаях будет отображена информация о сборке нужной ветки / нужного коммита.