Update documentation for read(units)

jasonray · Nov 18, 2023 · 9256057 · 9256057
2 parents 1179a6a + c9b098e
commit 9256057
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -41,7 +41,10 @@ const stopwatch = new statman.Stopwatch();
 -   `start()` => starts the stopwatch, let the timing begin!
 
 ### read
--   `read(precision)` => reads the stopwatch to determine how much time has elapsed.  Note that the stopwatch continues to run.  Returns the time elapsed in milliseconds.  If `precision` is provided, `read()` will round to the number of decimals places based on precision.
+-   `read(precision, units)` => reads the stopwatch to determine how much time has elapsed.  Note that the stopwatch continues to run.  Returns the time elapsed in milliseconds.
+    -   If `precision` is provided, `read()` will round to the number of decimals places based on precision.  
+    -   By default, `read` returns in `ms`.  If `units` is specified to `s`, will return values in seconds.
+
 -   `time(precision)` => alias for `read()`
 
 ### stop, suspend