From fb861e38de4e05d06329b731007a7de3bd592901 Mon Sep 17 00:00:00 2001 From: Aric Camarata Date: Sun, 8 Mar 2026 17:10:36 -0400 Subject: [PATCH] docs: add Architecture section; rename Related Packages heading to Related --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a41363..582cf25 100644 --- a/README.md +++ b/README.md @@ -169,11 +169,17 @@ const h: HijriDate = { hy: 1444, hm: 9, hd: 1 }; const opts: ConversionOptions = { calendar: 'fcna' }; ``` +## Architecture + +A thin adapter over [hijri-core](https://github.com/acamarata/hijri-core). Each function is a stateless wrapper that delegates to the registered calendar engine. No global state, no configuration object — pass options per call. + +For more detail see the [Architecture wiki page](https://github.com/acamarata/date-fns-hijri/wiki/Architecture). + ## Documentation Full API reference, architecture notes, and examples: [Wiki](https://github.com/acamarata/date-fns-hijri/wiki) -## Related Packages +## Related - [hijri-core](https://github.com/acamarata/hijri-core) - Zero-dependency Hijri engine powering this library - [luxon-hijri](https://github.com/acamarata/luxon-hijri) - Hijri support for Luxon DateTime objects