Skip to content

Commit 2a3446f

Browse files
docs(README): use minimum change approach
1 parent 1b74ca1 commit 2a3446f

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,20 +73,21 @@ A meeting is exactly that: a meeting between the people in a [match](#match)
7373
with a specific time and venue (e.g. a specific Zoom link). In order to support
7474
[complex recurrence rules](#recurring-meetings), a meeting's time consists of:
7575

76-
- **Start date:** The start time of the first meeting instance.
77-
- **Duration:** The meeting's duration in milliseconds. Stored in milliseconds
78-
to match JavaScript's `Date` object precision.
79-
- **End date:** The last possible meeting end time. If a meeting is recurring,
80-
this will be the end time of the last meeting instance in that recurring
81-
range. Or, if the recurring range is infinite, we use [JavaScript's max
82-
date](https://stackoverflow.com/questions/11526504/minimum-and-maximum-date)
83-
(Fri Sep 12 275760) which is more than sufficient.
84-
- **RRULE:** The time's recurrence rule as defined in [the iCalendar
76+
- **From:** The start time of this particular meeting instance.
77+
- **To:** The end time of this particular meeting instance.
78+
- **Recur:** The time's recurrence rule as defined in [the iCalendar
8579
RFC](https://tools.ietf.org/html/rfc5545). This is used server-side by
8680
[`rrule`](https://www.npmjs.com/package/rrule) to calculate individual
8781
meeting instances that are then sent to the client. It is manipulated
8882
client-side when users select a recurrence rule or choose to add an
8983
exception to a recurring meeting.
84+
- **Last:** The last possible meeting end time. If a meeting is recurring,
85+
this will be the end time of the last meeting instance in that recurring
86+
range. Or, if the recurring range is infinite, we use [JavaScript's max
87+
date](https://stackoverflow.com/questions/11526504/minimum-and-maximum-date)
88+
(Fri Sep 12 275760) which is more than sufficient. This is calculated and
89+
assigned server-side using [`rrule`](https://www.npmjs.com/package/rrule). It
90+
is completely ignored client-side (in favor of the `to` property).
9091

9192
Upon creation, Tutorbook sends an email to all of the `people` in the new
9293
meeting's match with the meeting time, venue, and everyone's contact info.

0 commit comments

Comments
 (0)