diff --git a/README.md b/README.md index c970493..c66ebaa 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,18 @@ keeping things simple and easy to use. ------ +### Highlights ✨ + +- Lightweight with no external dependencies other than `kotlinx:kotlinx-coroutines-core` from the Kotlin standard library. +- Designed to respect time zones, allowing you to set the time zone yourself or use the system's time zone by default. +- Provides four different types of triggers to execute jobs daily, at certain intervals, once at a given time, or with a cron-like schedule. +- Can run multiple instances of a job concurrently while giving you the option to run only one instance if the job is already executing. +- Can be easily extended to suit your specific use case by allowing you to write custom triggers and job stores. +- Easy to use and straightforward API with full KDoc/Javadoc documentation coverage. +- 100% unit test coverage to ensure reliability across different scenarios. + +------ + ### Installation 🛠️ Add the Jitpack repository in your build configuration: @@ -38,7 +50,6 @@ dependencies { implementation("com.github.Pool-Of-Tears:KtScheduler:version") } ``` - ------ ### Documentation 📑 diff --git a/build.gradle.kts b/build.gradle.kts index e928b94..3f86dd5 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -15,10 +15,11 @@ repositories { } dependencies { - testImplementation(kotlin("test")) // Coroutines implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.1") - // Test + + // Testing + testImplementation(kotlin("test")) testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.8.1") testImplementation("org.mockito:mockito-core:4.6.1") testImplementation("org.mockito:mockito-inline:4.6.1")