From a4637265dc6acef03027a138ab095fe9b7d3b1e4 Mon Sep 17 00:00:00 2001
From: Pavlo Nikitin <pawlo2102@gmail.com>
Date: Wed, 6 Nov 2019 09:06:55 +0200
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index bc6fecb..a8427c3 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,48 @@
 [![](https://jitpack.io/v/VRGsoftUA/coreAndroid.svg)](https://jitpack.io/#VRGsoftUA/coreAndroid)
 
 core modules for android applications
+
+*Все модули предполагают использование Kodein в качестве di.
+
+## retrofit
+
+модуль для упрощения работы с Retrofit. 
+
+##### Использование
+
+1. Настроить конфигурацию модуля в Application классе приложения:
+```gradle
+RetrofitConfig.apply {
+            baseUrl = baseUrlValue  // укажите базовый url
+            auth = interceptor      // укажите интерцептор для создания хедера авторизации (необходимо наследовать от Auth класса)
+            enableLogging()         // если необходимо логгирование, включите его посредством вызова этого метода
+        }
+```
+
+2. Подключите модуль в di:
+```gradle
+object AppModule {
+    fun module(application: App) = Kodein.Module("AppModule") {
+        //...
+        import(RetrofitModule.get())
+        //...
+    }
+}
+
+```
+
+После этого можно инджектить Retrofit класс где это необходимо.
+
+##### Подключение
+
+```gradle
+allprojects {
+    repositories {
+        maven { url 'https://jitpack.io' }
+    }
+}
+
+dependencies {
+   implementation "com.github.VRGsoftUA.coreAndroid:retrofit:$coreAndroid_version"
+}
+```