funscheduler

commit 1e34ff1e8f5e3061bc8e9d8f1a888b0e75981e54
parent d7c68af31741e003fae919d0c5a1173d608526f0
Author: Jackson G. Kaindume <seestem@protonmail.com>
Date:   Fri, 16 Jul 2021 00:27:29 +0200

docs and comments

Diffstat:
M
README
 | 
14
+++++++-------
M
src/lib.rs
 | 
3
++-

2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/README b/README
@@ -3,7 +3,7 @@
                └  └─┘┘└┘└─┘└─┘┴ ┴└─┘─┴┘└─┘┴─┘└─┘┴└─
 
 ----------------------------------------------------------------------
-  Simple time based function execution scheduler
+  Time based function execution scheduler
 ----------------------------------------------------------------------
 
     use funscheduler::{FunScheduler, Timing};
@@ -18,16 +18,16 @@
     }
 
 ----------------------------------------------------------------------
-  Timings: Easily congigure the timing of the function execution
+  Timings allow simple congiguration of the function execution
 ----------------------------------------------------------------------
 
-      Timing::Seconds(1)    // Every second
-      Timing::Minutes(25)   // Every 25 minutes
-      Timing::Hours(2)      // Every 2 hours
-      Timing::Days(1)       // Every day same as Timing::Hours(24)
+    Timing::Seconds(1)
+    Timing::Minutes(25)
+    Timing::Hours(2)
+    Timing::Days(1)
     
 ----------------------------------------------------------------------
-  Job runners: Different ways to execute the function
+  Job runners, different methods/ways to execute the function
 ----------------------------------------------------------------------
 
     // Evaluates a function at specified intervals, starting now
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,5 @@
-//! # Time based function execution scheduler
+//! # funscheduler
+//! Time based function execution scheduler
 use std::time::Duration;
 
 /// Timing configuration