Merge pull request #62 from bjuppa/doc-toc

Add table of contents to docs
bjuppa · Jul 6, 2023 · c43c0f1 · c43c0f1
2 parents 2743aaa + e32b572
commit c43c0f1
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -7,9 +7,12 @@ 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&hellip;
 
-[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
 
@@ -18,6 +21,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

diff --git 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
  *