Create README.md

Author: ggrachdev

README.md

@@ -0,0 +1,73 @@
+Что это?
+--------------------------  
+
+BitrixDebugger - библиотека для дебага в 1с битрикс, которая позволяет выводить данные в дебаг-панель, логировать в файлы, в будущем появится функционал 
+вывода дебаг-данных на месте вызова методов.
+
+Зачем мне это?
+--------------------------  
+
+Из проекта в проект я видел картину, что каждый разработчик реализует свою дебаг-функцию, которая в целом делает то же самое - вывод код внутри тега \<pre\>. Согласитесь, было бы удобнее скачать библиотеку и настроить в IDE сниппеты для нее
+
+Как пользоваться?
+--------------------------  
+Зайдите в Вашу папку php_interface где лежит так же файл init.php и введите команду (либо скачайте архив с данного репозитория):
+
+```console
+$ git clone https://github.com/ggrachdev/BitrixDebugger
+```
+Далее в файле init.php подключите библиотеку
+```php
+<?php
+
+include 'BitrixDebugger/initializer.php';
+```
+
+Чтобы получить дебаг-данные в дебаг-панели введите в любом месте в коде (данные будут отображены в разных вкладках панели):
+```php
+<?php
+
+GD()->notice('Моя переменная', 'Моя переменная 2');
+GD()->error('Моя переменная', 'Моя переменная 2');
+GD()->warning('Моя переменная', 'Моя переменная 2');
+GD()->success('Моя переменная', 'Моя переменная 2', 'Моя переменная 3', ['test' => [
+    'testSubKey1' => [
+        1,2,3
+    ],
+    'testSubKey2' => [
+        1,2,3
+    ],
+    'testSubKey3' => [
+        1,2,3
+    ]
+]]);
+```
+
+Так же можно логировать дебаг-данные в файлы (Эти данные не будут отображены в дебаг-панели, а буду записываться в файлы при хите):
+```php
+<?php
+
+GD()->noticeLog('Моя переменная', 'Моя переменная 2');
+GD()->errorLog('Моя переменная', 'Моя переменная 2');
+GD()->warningLog('Моя переменная', 'Моя переменная 2');
+GD()->successLog('Моя переменная', 'Моя переменная 2', 'Моя переменная 3');
+```
+
+Папку для логирования можно настроить в файле initializer.php
+```php
+<?php
+
+$ggrachDebuggerConfigurator->setLogPath('error', __DIR__ . '/logs/error.log');
+$ggrachDebuggerConfigurator->setLogPath('warning', __DIR__ . '/logs/warning.log');
+$ggrachDebuggerConfigurator->setLogPath('success', __DIR__ . '/logs/success.log');
+$ggrachDebuggerConfigurator->setLogPath('notice', __DIR__ . '/logs/notice.log');
+```
+
+В данный момент дебаг-данные отображаются только в дебаг-панели, на месте вызова отображать нельзя. Дебаг-панель видна только пользователям, которые являются администраторами.
+
+Данные в дебаг-панели можно скрывать, раскрывать, если присутствует переменная-строка. Если она больше 200 символов, то будет замена на [Очень длинный текст] и удаляются все html теги, чтобы исключить ошибки в отображении
+
+Тестировалась скорость формирования страницы с библиотекой и без, при ее наличии скорость дольше примерно на 0,01 сек., что не значительно замедляет проект.
+
+Дебаг-панель:
+[Скриншот](https://prnt.sc/zz8h04)