Merge pull request #3 from funyin/release/0.0.3

Release/0.0.3
funyin · Dec 3, 2023 · 49ae912 · 49ae912
2 parents 1af9e9b + 58a3af1
commit 49ae912
Show file tree

Hide file tree

Showing 26 changed files with 123 additions and 132 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -30,5 +30,5 @@ jobs:
           git fetch origin gh-pages --depth=1
           git config user.name ci-bot
           git config user.email [email protected]
-          mike deploy --push --update-aliases 0.0.2 latest
+          mike deploy --push --update-aliases 0.0.3 latest
           mike set-default --push latest
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+## 0.0.3 - Dec 3
+- Changed initialization to only collect connection string
+- Updated Docs
+
+## 0.0.2 - Dec 2
+- Initial release
diff --git a/README.md b/README.md
@@ -12,12 +12,12 @@ The persistent job scheduling library for kotlin multiplatform.
 
 ```kotlin
 suspend fun main() {
-    val mongoClient = MongoClient.create("mongodb://localhost:27017")
-    val redisClient = RedisClient.create("redis://localhost:6379")
-    val connection = redisClient.connect()
 
     //Initialize
-    Kronos.init(mongoClient = mongoClient, redisConnection = connection)
+    Kronos.init(
+        mongoConnectionString = "mongodb://localhost:27017",
+        redisConnectionString = "redis://localhost:6379"
+    )
     //Register a Job
     Kronos.register(SayHello)
     //Schedule a one time job

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -9,7 +9,7 @@ plugins {
 
 group = "com.funyinkash"
 //version = "0.0.1-SNAPSHOT"
-version = "0.0.2"
+version = "0.0.3"
 
 repositories {
     mavenCentral()

diff --git a/docs/index.md b/docs/index.md
@@ -6,12 +6,11 @@ Welcome to Kronos. The persistent job scheduling library for kotlin multiplatfor
 
 ```kotlin
 suspend fun main() {
-    val mongoClient = MongoClient.create("mongodb://localhost:27017")
-    val redisClient = RedisClient.create("redis://localhost:6379")
-    val connection = redisClient.connect()
-
     //Initialize
-    Kronos.init(mongoClient = mongoClient, redisConnection = connection)
+    Kronos.init(
+        mongoConnectionString = "mongodb://localhost:27017",
+        redisConnectionString = "redis://localhost:6379"
+    )
     //Register a Job
     Kronos.register(SayHello)
     //Schedule a one time job

diff --git a/docs/installation.md b/docs/installation.md
@@ -19,7 +19,7 @@ Kronos is pushed to MavenCentral repository as kotlin multiplatform library.
     Add dependencies:
 
     ```kotlin
-    implementation("com.funyinkash:kronos:0.0.2")
+    implementation("com.funyinkash:kronos:$latest")
     ```
 
 === "Gradle"
@@ -35,7 +35,7 @@ Kronos is pushed to MavenCentral repository as kotlin multiplatform library.
     Add dependencies (you can also add other modules that you need):
 
     ```groovy
-    implementation 'com.funyinkash:kronos:0.0.2'
+    implementation 'com.funyinkash:kronos:$latest'
     ```
 
 === "Maven" 
@@ -59,7 +59,7 @@ Kronos is pushed to MavenCentral repository as kotlin multiplatform library.
     <dependency>
         <groupId>com.funyinkash</groupId>
         <artifactId>kronos</artifactId>
-        <version>0.0.2</version>
+        <version>$latest</version>
     </dependency>
     ```
 
@@ -68,10 +68,7 @@ Specific dependencies. The Multiplatform dependency above should be sufficient,
 
 === "jvm"
     ```kotlin
-    implementation("com.funyinkash:kronos-jvm:0.0.2")
-    //supporting libraries that are required to initialize kronos
-    implementation("org.mongodb:mongodb-driver-kotlin-coroutine:4.11.1")
-    implementation("io.lettuce:lettuce-core:6.3.0.RELEASE")
+    implementation("com.funyinkash:kronos-jvm:$latest")
     ```
 
 === "js"

diff --git a/example/app/build.gradle.kts b/example/app/build.gradle.kts
@@ -10,20 +10,17 @@ repositories {
 //    maven {
 //        url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
 //    }
-//    mavenLocal()
+    mavenLocal()
 }
 
 dependencies {
-    implementation("com.funyinkash:kronos:0.0.2")
+    implementation("com.funyinkash:kronos:0.0.3")
 //    implementation(project(":kronos"))
     testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
     testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.2")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     implementation("com.google.guava:guava:31.1-jre")
-    implementation("org.mongodb:mongodb-driver-kotlin-coroutine:4.11.1")
-    implementation("io.lettuce:lettuce-core:6.3.0.RELEASE")
-    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.0")
-    implementation("org.mongodb:bson-kotlinx:4.11.1")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.0")
 }
 
 java {

diff --git a/example/app/src/main/kotlin/example/App.kt b/example/app/src/main/kotlin/example/App.kt
@@ -1,18 +1,17 @@
 package example
 
-import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.lettuce.core.RedisClient
+
 import kotlinx.coroutines.delay
 import kronos.*
 import java.time.Instant
 
 suspend fun main() {
-    val mongoClient = MongoClient.create("mongodb://localhost:27017")
-    val redisClient = RedisClient.create("redis://localhost:6379")
-    val connection = redisClient.connect()
 
     //Initialize
-    Kronos.init(mongoClient = mongoClient, redisConnection = connection)
+    Kronos.init(
+        mongoConnectionString = "mongodb://localhost:27017",
+        redisConnectionString = "redis://localhost:6379"
+    )
     //Register a Job
     Kronos.register(SayHello)
     //Schedule a one time job
@@ -47,7 +46,6 @@ suspend fun main() {
     jobId?.let { Kronos.dropJob(SayHello.name) }
 
     Kronos.dropAll()
-
     delay(1000 * 60 * 7)
 }
 

diff --git a/site/404.html b/site/404.html
@@ -11,7 +11,7 @@
 
 
 
-      <link rel="icon" href="/Kronos/0.0.2/assets/images/favicon.png">
+      <link rel="icon" href="/Kronos/0.0.3/assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.14">
 
 
@@ -20,10 +20,10 @@
 
 
 
-      <link rel="stylesheet" href="/Kronos/0.0.2/assets/stylesheets/main.fad675c6.min.css">
+      <link rel="stylesheet" href="/Kronos/0.0.3/assets/stylesheets/main.fad675c6.min.css">
 
 
-        <link rel="stylesheet" href="/Kronos/0.0.2/assets/stylesheets/palette.356b1318.min.css">
+        <link rel="stylesheet" href="/Kronos/0.0.3/assets/stylesheets/palette.356b1318.min.css">
 
 
 
@@ -42,7 +42,7 @@
 
 
 
-    <script>__md_scope=new URL("/Kronos/0.0.2",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("/Kronos/0.0.3",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
 
 
@@ -92,7 +92,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="/Kronos/0.0.2/." title="Kronos" class="md-header__button md-logo" aria-label="Kronos" data-md-component="logo">
+    <a href="/Kronos/0.0.3/." title="Kronos" class="md-header__button md-logo" aria-label="Kronos" data-md-component="logo">
 
 
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
@@ -200,7 +200,7 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="/Kronos/0.0.2/." title="Kronos" class="md-nav__button md-logo" aria-label="Kronos" data-md-component="logo">
+    <a href="/Kronos/0.0.3/." title="Kronos" class="md-nav__button md-logo" aria-label="Kronos" data-md-component="logo">
 
 
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
@@ -230,7 +230,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/Kronos/0.0.2/." class="md-nav__link">
+      <a href="/Kronos/0.0.3/." class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -250,7 +250,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/Kronos/0.0.2/installation/" class="md-nav__link">
+      <a href="/Kronos/0.0.3/installation/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -270,7 +270,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/Kronos/0.0.2/quick_start/" class="md-nav__link">
+      <a href="/Kronos/0.0.3/quick_start/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -310,7 +310,7 @@
 
 
 
-    <a href="/Kronos/0.0.2/job/" class="md-nav__link">
+    <a href="/Kronos/0.0.3/job/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -356,7 +356,7 @@
 
 
 
-    <a href="/Kronos/0.0.2/schedule/" class="md-nav__link">
+    <a href="/Kronos/0.0.3/schedule/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -382,7 +382,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/Kronos/0.0.2/why_how/" class="md-nav__link">
+      <a href="/Kronos/0.0.3/why_how/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -420,7 +420,7 @@
 
 
 
-    <a href="/Kronos/0.0.2/examples/" class="md-nav__link">
+    <a href="/Kronos/0.0.3/examples/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -466,7 +466,7 @@
 
 
     <li class="md-nav__item">
-      <a href="/Kronos/0.0.2/roadmap/" class="md-nav__link">
+      <a href="/Kronos/0.0.3/roadmap/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -506,7 +506,7 @@
 
 
 
-    <a href="/Kronos/0.0.2/community/" class="md-nav__link">
+    <a href="/Kronos/0.0.3/community/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
@@ -636,10 +636,10 @@ <h1>404 - Not found</h1>
     </div>
 
 
-    <script id="__config" type="application/json">{"base": "/Kronos/0.0.2", "features": ["navigation.prune", "navigation.indexes", "navigation.path", "navigation.top", "search.suggest", "search.highlight", "content.action.edit", "content.code.copy", "navigation.footer"], "search": "/Kronos/0.0.2/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
+    <script id="__config" type="application/json">{"base": "/Kronos/0.0.3", "features": ["navigation.prune", "navigation.indexes", "navigation.path", "navigation.top", "search.suggest", "search.highlight", "content.action.edit", "content.code.copy", "navigation.footer"], "search": "/Kronos/0.0.3/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
 
 
-      <script src="/Kronos/0.0.2/assets/javascripts/bundle.cd18aaf1.min.js"></script>
+      <script src="/Kronos/0.0.3/assets/javascripts/bundle.cd18aaf1.min.js"></script>
 
 
   </body>

diff --git a/site/community/contributing/index.html b/site/community/contributing/index.html
@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.2/community/contributing/">
+        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.3/community/contributing/">
 
 
         <link rel="prev" href="../">
@@ -69,23 +69,23 @@
 
         <meta  property="og:description"  content="None" >
 
-        <meta  property="og:image"  content="https://funyin.github.io/Kronos/0.0.2/assets/images/social/community/contributing.png" >
+        <meta  property="og:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/community/contributing.png" >
 
         <meta  property="og:image:type"  content="image/png" >
 
         <meta  property="og:image:width"  content="1200" >
 
         <meta  property="og:image:height"  content="630" >
 
-        <meta  property="og:url"  content="https://funyin.github.io/Kronos/0.0.2/community/contributing/" >
+        <meta  property="og:url"  content="https://funyin.github.io/Kronos/0.0.3/community/contributing/" >
 
         <meta  name="twitter:card"  content="summary_large_image" >
 
         <meta  name="twitter:title"  content="Contribute - Kronos" >
 
         <meta  name="twitter:description"  content="None" >
 
-        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.2/assets/images/social/community/contributing.png" >
+        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/community/contributing.png" >
 
 
 

diff --git a/site/community/index.html b/site/community/index.html
@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.2/community/">
+        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.3/community/">
 
 
         <link rel="prev" href="../roadmap/">
@@ -71,23 +71,23 @@
 
         <meta  property="og:description"  content="None" >
 
-        <meta  property="og:image"  content="https://funyin.github.io/Kronos/0.0.2/assets/images/social/community/index.png" >
+        <meta  property="og:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/community/index.png" >
 
         <meta  property="og:image:type"  content="image/png" >
 
         <meta  property="og:image:width"  content="1200" >
 
         <meta  property="og:image:height"  content="630" >
 
-        <meta  property="og:url"  content="https://funyin.github.io/Kronos/0.0.2/community/" >
+        <meta  property="og:url"  content="https://funyin.github.io/Kronos/0.0.3/community/" >
 
         <meta  name="twitter:card"  content="summary_large_image" >
 
         <meta  name="twitter:title"  content="Community - Kronos" >
 
         <meta  name="twitter:description"  content="None" >
 
-        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.2/assets/images/social/community/index.png" >
+        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/community/index.png" >