From 06bd7591873364f694dd300ecdc0cfa023158441 Mon Sep 17 00:00:00 2001 From: miiila Date: Tue, 6 Jun 2017 16:28:07 +0200 Subject: [PATCH] feat: document new setup --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c1b7477..e51ee51 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ - `PAGERDUTY_READ_ONLY_TOKEN` is used for reading schedules and checking the overlaps. - `SCHEDULES` array can contain one or more `SCHEDULE` items to check - every `SCHEDULE` should have a `NOTIFICATIONS` to create incident or send message if overlap is found -- `SCHEDULE` can contain a `DAYS` key, which speficies numbers of days in UTC (0 = Sunday) for verification (`[0, 1, 2, 3, 4]` below represents days without weekend) +- `SCHEDULE` can contain a `EXCLUSION_DAYS` key, which specifies days (3 letter abb.) in form of object with optional `start` and `end` time (`hh:mm` format). If `start` or `end` is omitted, whole day is considered excluded. +Example below represents current weekend on-call setup. All datetimes are translated to UTC, so feel free to use a local time. Currently, we only support Slack (`SLACK` with `SLACK_WEBHOOK_URL` and `CHANNEL`) and PagerDuty (`PAGERDUTY_TOKEN`) notifications. @@ -37,7 +38,7 @@ Currently, we only support Slack (`SLACK` with `SLACK_WEBHOOK_URL` and `CHANNEL` "NOTIFICATIONS": { "PAGERDUTY_TOKEN": "22222222222222222222" }, - "DAYS": [0, 1, 2, 3, 4] + "EXCLUSION_DAYS": {"Fri": {"start": "16:00", "end": "23:59"}, "Sat": {}, "Sun": {"start": "00:00", "end": "16:00"}} }] } ```