updated docs for version 0.0.3

funyin · Dec 3, 2023 · 58a3af1 · 58a3af1
1 parent cce1e42
commit 58a3af1
Show file tree

Hide file tree

Showing 16 changed files with 86 additions and 90 deletions.
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" >
 
 
 

diff --git a/site/examples/index.html b/site/examples/index.html
@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.2/examples/">
+        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.3/examples/">
 
 
         <link rel="prev" href="../why_how/">
@@ -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/examples/index.png" >
+        <meta  property="og:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/examples/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/examples/" >
+        <meta  property="og:url"  content="https://funyin.github.io/Kronos/0.0.3/examples/" >
 
         <meta  name="twitter:card"  content="summary_large_image" >
 
         <meta  name="twitter:title"  content="Index - Kronos" >
 
         <meta  name="twitter:description"  content="None" >
 
-        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.2/assets/images/social/examples/index.png" >
+        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/examples/index.png" >
 
 
 

diff --git a/site/index.html b/site/index.html
@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.2/">
+        <link rel="canonical" href="https://funyin.github.io/Kronos/0.0.3/">
 
 
 
@@ -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/index.png" >
+        <meta  property="og:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/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/" >
+        <meta  property="og:url"  content="https://funyin.github.io/Kronos/0.0.3/" >
 
         <meta  name="twitter:card"  content="summary_large_image" >
 
         <meta  name="twitter:title"  content="Overview" >
 
         <meta  name="twitter:description"  content="None" >
 
-        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.2/assets/images/social/index.png" >
+        <meta  name="twitter:image"  content="https://funyin.github.io/Kronos/0.0.3/assets/images/social/index.png" >
 
 
 
@@ -671,12 +671,11 @@ <h1 id="overview">Overview</h1>
 <p>Welcome to Kronos. The persistent job scheduling library for kotlin multiplatform.</p>
 <h3 id="summary">Summary</h3>
 <div class="highlight"><pre><span></span><code><span class="kd">suspend</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
-<span class="w">    </span><span class="kd">val</span><span class="w"> </span><span class="nv">mongoClient</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">MongoClient</span><span class="p">.</span><span class="na">create</span><span class="p">(</span><span class="s">&quot;mongodb://localhost:27017&quot;</span><span class="p">)</span>
-<span class="w">    </span><span class="kd">val</span><span class="w"> </span><span class="nv">redisClient</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">RedisClient</span><span class="p">.</span><span class="na">create</span><span class="p">(</span><span class="s">&quot;redis://localhost:6379&quot;</span><span class="p">)</span>
-<span class="w">    </span><span class="kd">val</span><span class="w"> </span><span class="nv">connection</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">redisClient</span><span class="p">.</span><span class="na">connect</span><span class="p">()</span>
-
 <span class="w">    </span><span class="c1">//Initialize</span>
-<span class="w">    </span><span class="n">Kronos</span><span class="p">.</span><span class="na">init</span><span class="p">(</span><span class="n">mongoClient</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mongoClient</span><span class="p">,</span><span class="w"> </span><span class="n">redisConnection</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">connection</span><span class="p">)</span>
+<span class="w">    </span><span class="n">Kronos</span><span class="p">.</span><span class="na">init</span><span class="p">(</span>
+<span class="w">        </span><span class="n">mongoConnectionString</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;mongodb://localhost:27017&quot;</span><span class="p">,</span>
+<span class="w">        </span><span class="n">redisConnectionString</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;redis://localhost:6379&quot;</span>
+<span class="w">    </span><span class="p">)</span>
 <span class="w">    </span><span class="c1">//Register a Job</span>
 <span class="w">    </span><span class="n">Kronos</span><span class="p">.</span><span class="na">register</span><span class="p">(</span><span class="n">SayHello</span><span class="p">)</span>
 <span class="w">    </span><span class="c1">//Schedule a one time job</span>