Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
pavanmankar committed Jan 21, 2024
2 parents 58f2534 + 1a7df88 commit ade27d9
Showing 1 changed file with 3 additions and 31 deletions.
34 changes: 3 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,19 @@
This repository contains a sample app that implements MVVM architecture using Kotlin, Dagger,
Retrofit, Coroutines, Flow, StateFlow, etc.


## Using Library in your Android application

Update your settings.gradle file with the following dependency.

```groovy
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
}
```

Update your module level build.gradle file with the following dependency.

```groovy
dependencies {
implementation 'com.github.pavanmankar:newsTrending:Tag'
}
```
Do not forget to add internet permission in manifest if already not present

```
<uses-permission android:name="android.permission.INTERNET" />
```

## Major Highlights

- MVVM Architecture
- Kotlin
- Dagger Hilt
- Dagger2
- Retrofit
- Coroutines
- Flows
- Stateflow
- View binding
- Unit Test

#### The app contains following packages:
#### The app contains the following packages:
1. **data**: It contains all the data accessing and manipulating components.
2. **di**: Dependency providing classes using Dagger2.
3. **ui**: View classes along with their corresponding ViewModel.
Expand Down Expand Up @@ -75,7 +47,7 @@ The main advantage of using MVVM, there is no two-way dependency between ViewMod
### License

```
Copyright (C) 2022 Amit Shekhar
Copyright (C) 2022
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit ade27d9

Please sign in to comment.