Create README.md

Author: grigoriev-semyon

README.md

@@ -1,2 +1,15 @@
 # auth-api
 API сервиса аутентификации и авторизации в приложение Твой ФФ!
+
+# Инструкция, как оно работает 
+1. Архитектура
+Для добавления методов авторизации используется плагинная архитектура. Это сделано для того, чтобы очень быстро, практически не меняя существующий код внедрять новые методы авторизации. Новые методы внедряются с помощью наследованния от метакласса AuthMethod. Все остальное сделано по обычным паттернам.
+
+2. Регистрация через email
+Чтобы зарегистрироваться через email надо дернуть ручку /email/registrate. Туда передается email и пароль через json. Регситрация через email доступна для незарегестрированных пользователей или для пользователей у которых определены методы регистрации, но не email. Возможны несколько исходов регистрации:
+2.1 Успешно - 201
+Если пользователь зарегестрирован и 
+Возвращает т.н ResponseModel = {status: "", message: ""}
+
+3. Логин через email. 
+Чтобы залогиниться надо дернуть ручку email/login.