From 32086d817aeb4cdf0e9d5c97804a6fa8e7361684 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonatan=20M=C3=A4nnchen?= Date: Fri, 23 Dec 2016 14:56:13 +0000 Subject: [PATCH] Improve README --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f8f30de..cd31fe2 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,11 @@ Parse Cron Format Strings, Write Cron Format Strings and Caluclate Execution Dates. -## Installation +## Roadmap + * Support cron expressions including seconds + * Support `W` modifier -If [available in Hex](https://hex.pm/docs/publish), the package can be installed as: +## Installation 1. Add `crontab` to your list of dependencies in `mix.exs`: @@ -24,6 +26,11 @@ If [available in Hex](https://hex.pm/docs/publish), the package can be installed end ``` +## Unsupported Features +The 'W' character is allowed for the day-of-month field. This character is used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify "1W" as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days. + +The 'L' and 'W' characters can also be combined for the day-of-month expression to yield 'LW', which translates to "last weekday of the month". + ## Usage ### Parse Cron Format Strings