aric/date-fns-hijri
1
0
Fork 0
mirror of https://github.com/acamarata/date-fns-hijri.git synced 2026-06-30 18:54:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add Architecture section; rename Related Packages heading to Related

Browse source
This commit is contained in:
Aric Camarata 2026-03-08 17:10:36 -04:00
parent d2bbbf72c4
commit fb861e38de
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -169,11 +169,17 @@ const h: HijriDate = { hy: 1444, hm: 9, hd: 1 };
const opts: ConversionOptions = { calendar: 'fcna' }; 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 ## Documentation
Full API reference, architecture notes, and examples: [Wiki](https://github.com/acamarata/date-fns-hijri/wiki) 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 - [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 - [luxon-hijri](https://github.com/acamarata/luxon-hijri) - Hijri support for Luxon DateTime objects