From 0e951431345acc408809dbf94c54a3608a1a9648 Mon Sep 17 00:00:00 2001 From: Jitendra Adhikari Date: Wed, 21 Apr 2021 20:54:13 +0700 Subject: [PATCH] docs: IsValid usage --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c6c62a..919933c 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,14 @@ import ( gron := gronx.New() expr := "* * * * *" -// check if expr is due for current time -gron.IsDue(expr) +// check if expr is even valid, returns bool +gron.IsValid(expr) // true + +// check if expr is due for current time, returns bool and error +gron.IsDue(expr) // true|false, nil // check if expr is due for given time -gron.IsDue(expr, time.Date(2021, time.April, 1, 1, 1, 0, 0, time.UTC)) +gron.IsDue(expr, time.Date(2021, time.April, 1, 1, 1, 0, 0, time.UTC)) // true|false, nil ``` ---