Files
flexcal/README.md
Ian Roddis 6166c6d664 Squashed commit of the following:
commit 3fd1474140
Author: Ian Roddis <tech@kinesin.ca>
Date:   Wed Dec 8 14:01:28 2021 -0400

    Adding license and adjusting readme

commit 638659a467
Author: Ian Roddis <tech@kinesin.ca>
Date:   Wed Dec 8 13:55:40 2021 -0400

    Adding support for generating date ranges on date ranges
2021-12-08 14:04:28 -04:00

29 lines
768 B
Markdown

Introduction
============
A flexible calendar structure to support aribtrary and calculated
off days.
Calendars
=========
Definition
----------
Calendars consist of:
- Day of week list
- Date Exclusion List
- Dates are defined as:
- One of
- YYYY-MM-DD
- Add a specific date to a calendar's exclusion list
- Month and Day
- Month, Day of week, and an offset (e.g. 2nd Friday)
- Number can be relative, so 1 is first, -1 is last
- Optional `description`
- Optional `observed` attribute that is `Next`, `Prev`, `Closest`, `NoAdjustment` (default)
that is in the day of week mask and not also a holiday
- A name, which can contain letters, numbers, dashes, and underscores
- They cannot contain dots / periods