mirror of
https://github.com/InsanusMokrassar/krontab.git
synced 2024-11-22 08:13:54 +00:00
update readme to include week days info
This commit is contained in:
parent
86cdda51a1
commit
20f12f3f2d
27
README.md
27
README.md
@ -14,6 +14,7 @@ runtime of applications.
|
||||
| [ How to use: Config from string ](#config-from-string) |
|
||||
| [ How to use: Config via builder (DSL preview) ](#config-via-builder) |
|
||||
| [ How to use: KronScheduler as a Flow ](#KronScheduler-as-a-Flow) |
|
||||
| [ Note about week days ](#Note-about-week-days) |
|
||||
|
||||
## How to use
|
||||
|
||||
@ -52,14 +53,17 @@ For old version of Gradle, instead of `implementation` word developers must use
|
||||
|
||||
Developers can use more simple way to configure repeat times is string. String configuring
|
||||
like a `crontab`, but with a little bit different meanings:
|
||||
|
||||
```
|
||||
/---------- Seconds
|
||||
| /-------- Minutes
|
||||
| | /------ Hours
|
||||
| | | /---- Days of months
|
||||
| | | | /-- Months
|
||||
| | | | | / (optional) Year
|
||||
* * * * * *
|
||||
/--------------- Seconds
|
||||
| /------------- Minutes
|
||||
| | /----------- Hours
|
||||
| | | /--------- Days of months
|
||||
| | | | /------- Months
|
||||
| | | | | /----- (optional) Year
|
||||
| | | | | | /--- (optional) Timezone offset
|
||||
| | | | | | | / (optional) Week days
|
||||
* * * * * * 0o *w
|
||||
```
|
||||
|
||||
It is different with original `crontab` syntax for the reason, that expected that in practice developers
|
||||
@ -152,3 +156,12 @@ flow.takeWhile {
|
||||
action()
|
||||
}
|
||||
```
|
||||
|
||||
### Note about week days
|
||||
|
||||
Unlike original CRON, here week days:
|
||||
|
||||
* Works as `AND`: cron date time will search first day which will pass requirement according all parameters including
|
||||
week days
|
||||
* You may use any related to numbers syntax with week days: `0-3w`, `0,1,2,3w`, etc.
|
||||
* Week days (like years and offsets) are optional and can be placed anywhere after `month`
|
||||
|
Loading…
Reference in New Issue
Block a user