diff --git a/README.md b/README.md index f8b6fd4..cc8b77a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ -gocronexpression -================ +cronexpression for Go +===================== Go language (golang) cron expression parser. Given a cron expression and a time stamp, you can get the next time stamp which satisfy the cron expression. The reference documentation for this implementation is found at -https://en.wikipedia.org/wiki/Cron#CRON_expression +https://en.wikipedia.org/wiki/Cron#CRON_expression, with the following +difference: + +* Supports the second field (before minute field) +* If five fields are present, a wildcard year field is appended +* If six field are present, "0" is prepended as second field +* Domain for day-of-week field is [0-7] instead of [0-6], 7 being Sunday, like zero. +* `@reboot` is not supported, as it is meaningless for a cron expression parser library +* As of now, the behavior of the code is undetermined if a malformed cron expression is supplied (most likely, code will panic) Install -------