Skip to content

Commit 227ed77

Browse files
committed
updated readme
1 parent 7a6fa5a commit 227ed77

File tree

3 files changed

+20
-6
lines changed

3 files changed

+20
-6
lines changed

.idea/jarRepositories.xml

+15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,23 @@
33

44
![Android Build](https://github.com/t-regbs/MathAlarm/workflows/Android%20Build/badge.svg) ![My twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Ftimiaregbs) ![Shield](https://img.shields.io/badge/contributions-welcome-brightgreen)
55

6-
An Android alarm app in which you solve math problems of varying difficulty to dismiss alarm. Built with Kotlin, Room, Coroutines, the MVVM pattern, LiveData, ViewModel, Navigation Components, Data Binding and some other libraries from the [Android Jetpack](https://developer.android.com/jetpack) .
6+
An Android alarm app in which you solve math problems of varying difficulty to dismiss alarm. Built with Kotlin, Room, Coroutines, the MVVM pattern with Clean architecture, ViewModel, Jetpack compose and some other libraries from the [Android Jetpack](https://developer.android.com/jetpack) .
77

88
<a href='https://play.google.com/store/apps/details?id=com.timilehinaregbesola.mathalarm'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width="280"/></a>
99

1010
## Technologies used:
1111

12+
* [Jetpack Compose](https://developer.android.com/jetpack/compose) - Android’s modern toolkit for building native UI
1213
* [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) to store and manage UI-related data in a lifecycle conscious way.
13-
* [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) to handle data in a lifecycle-aware fashion.
14-
* [Navigation Component](https://developer.android.com/guide/navigation) to handle all navigations and also passing of data between destinations.
14+
* [Navigation Material](https://google.github.io/accompanist/navigation-material) - provides Compose Material support for Jetpack Navigation Compose, features composable bottom sheet destinations.
1515
* [Timber](https://github.com/JakeWharton/timber) - a logger with a small, extensible API which provides utility on top of Android's normal Log class.
1616
* [Material Design](https://material.io/develop/android/docs/getting-started/)
1717
* [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) used to manage the local storage i.e. `writing to and reading from the database`. Coroutines help in managing background threads and reduces the need for callbacks.
18-
* [Data Binding](https://developer.android.com/topic/libraries/data-binding/) to declaratively bind UI components in layouts to data sources.
1918
* [Room](https://developer.android.com/topic/libraries/architecture/room) persistence library which provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.
20-
* [Koin](https://doc.insert-koin.io/#/) pragmatic lightweight dependency injection framework for Kotlin developers.
19+
* [Dagger Hilt](https://dagger.dev/hilt/) provides a standard way to incorporate Dagger dependency injection into an Android application.
2120

2221
## Installation
23-
Math Alarm requires a minimum API level of 19. Clone the repository.
22+
Math Alarm requires a minimum API level of 21. Clone the repository.
2423

2524
## Contribution
2625
All contributions are welcome. Simply make a PR!

media/math_alarm_github.png

-93.4 KB
Loading

0 commit comments

Comments
 (0)