feat: init repository and publish first version

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a76e690
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+## Как это работает
+
+Скрипт бесконечно (до ручного отключения) собирает информацию с сконфигурированных syz-manager с определенных endpoint'ов и сохраняет их последнее состояние, а также лог изменений в коротком виде (количество +, -) и развернутом (весь лог изменений).
+
+## Установка
+
+Понадобится python3 и модули bs4 и requests.
+
+```sh
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
+## Конфигурация
+
+Добавлять менеджеры для наблюдения нужно в config.json в массив managers в формате:
+
+```json
+{
+    "name": "*Имя менеджера для сохранения результатов и сообщений об ошибках*",
+    "http_url": "*Адрес панели инфомации менеджера*"
+}
+```
+
+Добавление (или отключение) наблюдаемых ручек выполняется через массив endpoints.
+На текущий момент важными являются поля `name` и `http_uri`, имеющие аналогичное менеджеру значение.
+Кроме того поддерживается парсинг метрик в csv, а также парсинг основной страницы syz-manager dashboard для проверки наличия крешей.