Skip to content

Commit 94d420f

Browse files
update README.md
1 parent 1680bd7 commit 94d420f

2 files changed

Lines changed: 19 additions & 5 deletions

File tree

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
44
[![Kotlin Version](https://img.shields.io/badge/kotlin-1.4.0-blue.svg)](https://kotlinlang.org)
55
[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=21)
6+
[![codecov](https://codecov.io/gh/andremion/Theatre/graph/badge.svg)](https://codecov.io/gh/andremion/Theatre)
7+
68

79
## About
810

@@ -23,7 +25,8 @@ Unit tests are written with JUnit4, JUnit5, MockK, Truth, MockWebServer.
2325
* In core module dagger hilt dependencies and ```@EntryPoint``` is created
2426
* Data module uses Retrofit and Room to provide Local and Remote data sources
2527
* Repository provides offline and remote fetch function with mapping and local save, delete and fetch functions
26-
* Pagination with database
28+
* Domain module uses useCase classes to implment business logic to fetch and forward data
29+
* ViewModel uses LiveData with data-binding to display LOADING, and ERROR or SUCCESS states.
2730

2831
## Built With 🛠
2932

@@ -54,11 +57,22 @@ Some of the popular libraries and MVVM clean architecture used with offline-firs
5457
* Offline first/last with Room an Retrofit
5558
* [Dynamic feature modules](https://developer.android.com/studio/projects/dynamic-delivery)
5659
* Tests
57-
* [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) ([JUnit](https://junit.org/junit4/))
58-
* [Mockk](https://mockk.io/)
59-
*
60+
* [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) ([JUnit5](https://junit.org/junit5/)) ([JUnit4](https://junit.org/junit4/))
61+
* [MockWebServer](https://github.com/square/okhttp/tree/master/mockwebserver) Mock server for testing Api requests with OkHttp and Retrofit
62+
* [Mockk](https://mockk.io/) Mockking library for Kotlin
63+
* [Truth](https://truth.dev) Assertion library
6064
* Gradle
6165
* [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html)
6266
* Custom tasks
63-
* Plugins ([Ktlint](https://github.com/JLLeitschuh/ktlint-gradle), [Detekt](https://github.com/arturbosch/detekt#with-gradle), [SafeArgs](https://developer.android.com/guide/navigation/navigation-pass-data#Safe-args))
67+
* Plugins ([Ktlint](https://github.com/JLLeitschuh/ktlint-gradle), [Detekt](https://github.com/arturbosch/detekt#with-gradle), [SafeArgs](https://developer.android.com/guide/navigation/navigation-pass-data#Safe-args)), [Git Hooks](https://githooks.com)
68+
69+
70+
### Modularaization, Library and Feature Modules
71+
72+
Uses both library modules and dynamic feature modules
73+
74+
## Architecture
75+
76+
Uses concepts of clean architecture
77+
6478

screenshots/modules.png

21.4 KB
Loading

0 commit comments

Comments
 (0)