📝 Readme enhanced

AlbatovK · Oct 24, 2022 · aedef42 · aedef42
1 parent ee3ea9c
commit aedef42
Showing 1 changed file with 26 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -26,36 +26,36 @@ Android-приложение Directa (сокр. Dira) - это планер, к
 # Техническая характеристика проекта
 Проект состоит из Android-приложения, серверной части [(ссылка на репозиторий)](https://github.com/AlbatovK/DiraServer) и сторонних сервисов, добавляющих функционал в приложение.
 * Стэк технологий
-    * Kotlin Coroutines и Kotlin FLow - выполнение асинхронных операций для работы с сетью
-    * Retrofit - быстрый и удобный доступ к API со стороны клиента
-    * Spring Boot Framework - web-приложение развёрнутое на хостинге [(ссылка на сервер)](https://diraserver.herokuapp.com) Heroku
-    * Swagger2 - автоматическое создание документации API [(ссылка на документацию)](https://diraserver.herokuapp.com/swagger-ui.html)
-    * Google Firebase Firestore - серверная документоориентированная NoSql база данных
-    * Firebase Auth - аутенфикация пользователей
-    * SharedPreferences - хранение временных данных пользователя на устройстве
-    * Android Jetpack
-        * Fragment - использование нескольких экранов в рамках одной активности
-        * Navigation - навигация между фрагментами в рамках одной активности и создание вложенных контейнеров навигации
-        * Navigation SafeArgs Plugin - безопасная передача данных между фрагментами
-        * Lifecycle - обработка событий на основе жизненного цикла приложения
-        * ViewModel - хранение и использование данных относящихся к UI в привязке к жизненному циклу представления
-        * RecyclerView - представление данных в виде интерактивного списка
-        * ViewBinding - современный способ доступа к элементам разметки
+    * `Kotlin Coroutines` и `Kotlin FLow` - выполнение асинхронных операций для работы с сетью
+    * `Retrofit` - быстрый и удобный доступ к API со стороны клиента
+    * `Spring Boot Framework` - web-приложение развёрнутое на хостинге [(ссылка на сервер)](https://diraserver.herokuapp.com) Heroku
+    * `Swagger2` - автоматическое создание документации API [(ссылка на документацию)](https://diraserver.herokuapp.com/swagger-ui.html)
+    * `Google Firebase Firestore` - серверная документоориентированная NoSql база данных
+    * `Firebase Auth` - аутенфикация пользователей
+    * `SharedPreferences` - хранение временных данных пользователя на устройстве
+    * `Android Jetpack`
+        * `Fragment` - использование нескольких экранов в рамках одной активности
+        * `NavigationUI` - навигация между фрагментами в рамках одной активности и создание вложенных контейнеров навигации
+        * `Navigation SafeArgs Plugin` - безопасная передача данных между фрагментами
+        * `Lifecycle` - обработка событий на основе жизненного цикла приложения
+        * `ViewModel` - хранение и использование данных относящихся к UI в привязке к жизненному циклу представления
+        * `RecyclerView` - представление данных в виде интерактивного списка
+        * `ViewBinding` - современный способ доступа к элементам разметки
 * Современная архитектура
     * Многоуровневая архитектура
-    * Паттерн проектирования MVVM на стороне клиента
-    * Clean Architecture и UseCases
-    * Spring MVС на стороне сервера
-    * Koin - Инъекция зависимостей
-    * JUnit4 и Espresso - тестирование
+    * Паттерн проектирования `MVVM` на стороне клиента
+    * `Clean Architecture` и `UseCases`
+    * `Spring MVС` на стороне сервера
+    * `Koin` - Инъекция зависимостей
+    * `JUnit4` и `Espresso` - тестирование
 * Continious Integration
-    * GitHub Actions - сборка и анализ артефакта приложения с помощью Gradle
-    * Detekt - статический анализатор кода
-    * Автоматический анализ кода с помощью сторонних сервисов (Codebeat, Codefactor)
-    * Firebase Analytics и Firebase Crashlytics - отслеживание состояния приложения и сбор статистики в реальном времени
+    * `GitHub Actions` - сборка и анализ артефакта приложения с помощью Gradle
+    * `Detekt` - статический анализатор кода
+    * Автоматический анализ кода с помощью сторонних сервисов (`Codebeat`, `Codefactor`)
+    * `Firebase Analytics` и `Firebase Crashlytics` - отслеживание состояния приложения и сбор статистики в реальном времени
 * UI
-    * Material design
-    * MaterialUI - Элементы навигации Bottom Navigation и Navigation Drawer из NavigationUI
+    * `Material design`
+    * `MaterialUI` - Элементы навигации `Bottom Navigation` и `Navigation Drawer` из NavigationUI
 
 # Базовая структура
 ![](https://github.com/AlbatovK/KQuiz/blob/master/assets/circles.drawio.svg?raw=true)