Create README.md

README.md

@@ -0,0 +1,48 @@
+Что делает модуль?
+--------------------------  
+Модуль позволяет организовать мультирегиональность на Вашем сайте исходя из текущего url, например, 
+зашли на moscow.site.ru - будут одни данные, зашли на spb.site.ru - другие.
+В данный момент модуль может подставлять только формы названия города (Московский, Московская, Московское, Москва, Москве и тп, их заполняете самостоятельно), в будущем
+появится привязка к типам цен и возможность добавлять пользовательские поля, 
+чтобы модуль заработал нужно установить модуль, заполнить регионы и в init.php подключить модуль:
+
+```php
+\Bitrix\Main\Loader::includeModule('ggrachdev.multiregionality');
+```
+
+Теперь на странице вы можете вставлять плейсхолдеры:
+
+```html
+#NAME_REGION#
+#FORM_NAME_REGION_1#
+#FORM_NAME_REGION_2#
+#FORM_NAME_REGION_3#
+#FORM_NAME_REGION_4#
+#FORM_NAME_REGION_5#
+#FORM_NAME_REGION_6#
+```
+
+Они будут заменены на данные региона из инфоблока, можете так же работать с модулем через код:
+
+```php
+$regions = \GGrach\Multiregionality\RegionsFactory::getInstance();
+
+// Все регионы, массив array<GGrach\Multiregionality\Entity\Region>
+$arRegions = $regions->getRegionsData();
+
+// Данные текущего региона GGrach\Multiregionality\Entity\Region
+$nowRegion = $regions->getNowRegionData();
+
+Доступные методы:
+$nowRegion->getId();
+$nowRegion->getName();
+$nowRegion->getNameForms();
+$nowRegion->getUrl();
+$nowRegion->getData();
+$nowRegion->isDefaultRegion();
+```
+
+Если вам нужно определить текущий регион не исходя из текущего url, то передайте в фабрику параметр:
+```php
+$regions = \GGrach\Multiregionality\RegionsFactory::getInstance('irkutsk.site.ru');
+```