fix: more typescript cleaning and fixing, add more docs

README.md

@@ -27,10 +27,16 @@ With the `@calidy/dayjs-calendarsystems` plugin, we bring the capacity to run an
 ## Features
 
 - Register and use different calendar systems.
+- Typescript exports and definitions.
+- Compatible with all official Dayjs plugins.
+- No need for hacks, use dayjs apis in the standard way.
+- Small and light plugin, no overhead.
 - Convert between different calendar systems.
 - Default Gregorian calendar system included.
 - Persian Calendar system available.
-- Other calendar systems are still under development.
+- **[WIP]** Islamic (Hijri, Umalqura) Calendar system. Note: we will use the default "islamic-umalqura" calendar system for "islamic" calendar system.
+- **[WIP]** Hebrew (Jewish) Calendar system.
+- **[WIP]** Ethiopian Calendar system.
 - **[TODO]** Parse date strings from different calendar systems
 - **[TODO]** Add more tests for all Dayjs Plugins
 
@@ -60,6 +66,10 @@ import calendarSystems from "@calidy/dayjs-calendarsystems";
 
 import PersianCalendarSystem from "@calidy/dayjs-calendarsystems/calendarSystems/PersianCalendarSystem";
 
+// ...
+// ALL YOU OTHER dayjs.extend() calls
+// ...
+// After all other dayjs plugins are initialized, extend dayjs with our calendar systems plugin:
 dayjs.extend(calendarSystems);
 
 // Register new calendar system

types/index.d.ts

@@ -1,6 +1,11 @@
 import { PluginFunc, Dayjs } from 'dayjs';
 import { CalendarSystemBase } from './calendarSystems/CalendarSystemBase';
-export type CalendarSystem =  'persian' | 'gregorian' | 'islamic' | 'julian' | 'indian' | 'hebrew' | 'ethiopian' | 'coptic' | 'buddhist' | 'japanese' | 'roc' | 'nanakshahi' | 'isoWeek' | 'week' | 'quarter' | 'month' | 'year' | 'decade' | 'century' | 'millennium';
+// All Calendar Systems known to Intl API (alphabetical order)
+// 'buddhist' | 'chinese' | 'coptic' | 'dangi' | 'ethioaa' | 'ethiopic' | 'gregory' | 'hebrew' | 'indian' | 'islamic' | 'islamic-civil' | 'islamic-rgsa' | 'islamic-tbla' | 'islamic-umalqura' | 'islamicc' | 'iso8601' | 'japanese' | 'persian' | 'roc'
+// Our supported Calendar Systems (alphabetical order)
+export type CalendarSystem = 'gregory' | 'persian';
+// TODO: export type CalendarSystem = 'gregory' | 'persian' | 'islamic' | 'islamic-umalqura' | 'hebrew' | 'ethiopic';
+// ! Note that we use the default "islamic-umalqura" calendar system for "islamic" calendar system
 
 declare module 'dayjs' {
   interface Dayjs {