From 1f7b3a098b8d2c69ce95b03d3bcc82ca39861e6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Nilsved?= Date: Thu, 6 Jul 2023 17:36:05 +0200 Subject: [PATCH 1/4] Add table of contents --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index f1ade54..197db96 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,15 @@ ComPlainDate is distributed as an **npm** package as well as a **Deno** module: - [npmjs.com/package/complaindate](https://www.npmjs.com/package/complaindate) - [deno.land/x/complaindate](https://deno.land/x/complaindate/mod.ts) +## Table of contents + +1. [Introduction](#introduction) +2. [Quick example](#quick-example) +3. [Working with timezone strings](#working-with-timezone-strings) +4. [Why another JavaScript date-time library?](#why-another-javascript-date-time-library) +5. [Guiding principles](#guiding-principles) +6. [Limitations](#limitations) + ## Introduction ComPlainDate provides a few special objects and a bunch of utility functions to From 324d706262d2f057274319abdd5a80f24a7852b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Nilsved?= Date: Thu, 6 Jul 2023 17:36:57 +0200 Subject: [PATCH 2/4] Use hellip --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 197db96..3e841d8 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ times** on top of the JavaScript features already available in today's browsers and runtime systems. It may well be that ComPlainDate will stay useful even after Temporal is -available — only time will tell... +available — only time will tell… [API documentation and lists of available functions at deno.land](https://deno.land/x/complaindate/mod.ts) From 43ab999fa22a04849822f66f02fb80623b3e57b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Nilsved?= Date: Thu, 6 Jul 2023 17:37:45 +0200 Subject: [PATCH 3/4] Put API link in a section --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e841d8..5841b36 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,10 @@ and runtime systems. It may well be that ComPlainDate will stay useful even after Temporal is available — only time will tell… -[API documentation and lists of available functions at deno.land](https://deno.land/x/complaindate/mod.ts) +## API documentation + +The full [API documentation](https://deno.land/x/complaindate/mod.ts) and +categorized lists of available functions are available at deno.land. ## Installation From e32b5722fae0f9bb43994a03fc071995b777ab59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Nilsved?= Date: Thu, 6 Jul 2023 17:38:23 +0200 Subject: [PATCH 4/4] Simplify objects intro --- mod.ts | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/mod.ts b/mod.ts index 958f9e2..dad2f07 100644 --- a/mod.ts +++ b/mod.ts @@ -3,15 +3,13 @@ * * Date-time utilities that keeps timezones on the surface. * - * ## Main objects + * ## Objects * - * The {@link ComPlainDate} interface describes plain-date objects, that can be - * created with the {@link PlainDate} factory, described by the - * {@link PlainDateFactory} interface. + * The {@link ComPlainDate} interface describes plain-date objects that can be + * created with the {@link PlainDate} factory. * - * The {@link ComPlainTime} interface describes wall-time objects, that can be - * created with the {@link PlainTime} factory, described by the - * {@link PlainTimeFactory} interface. + * The {@link ComPlainTime} interface describes wall-time objects that can be + * created with the {@link PlainTime} factory. * * ### Extended objects * @@ -20,8 +18,9 @@ * always use the main objects with utility functions in frontend code! * * An extended type of plain-date object is described by the - * {@link ExtendedPlainDate} interface. Those objects are created with the - * {@link ExPlainDate} factory. + * {@link ExtendedPlainDate} interface. + * Those objects are created with the {@link ExPlainDate} factory, which also + * implements the optional functions of the {@link PlainDateFactory} interface. * * ## Utility functions *