Skip to content

Commit

Permalink
docs: linked the propsal repo
Browse files Browse the repository at this point in the history
  • Loading branch information
khawarizmus committed Apr 9, 2024
1 parent 2079d20 commit 022ed1a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,6 @@ jobs:
extra_plugins: |
@semantic-release/changelog
@semantic-release/git
node-version: lts/*
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]

A **Hijri Week Calendar** is an implementation of the ISO 8601 equivalent for the Hijri calendar. It is based on the [Hijri Calendar](https://en.wikipedia.org/wiki/Islamic_calendar) and the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. dates generated by this calendar are referred to as **Hijri Week Dates**.
Implementation of the [**Hijri Week Calendar** Standard proposal](https://github.com/khawarizmus/hijri-week-calendar-proposal) which is a counterpart of ISO 8601 week calendar for the Hijri calendar. It is based on the [Hijri Calendar](https://en.wikipedia.org/wiki/Islamic_calendar) and the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. dates generated by this calendar are referred to as **Hijri Week Dates**.

Since Hijri (islamic) calendars are lunar calendars, it was necessary to define a standard for them which has [slightly modified rules](#rules) from that of the ISO week based on the Gregorian calendar. Not withstanding the foregoing, the system shares many of the rules defined by the ISO 8601 making it compliant with the ISO standard.
Since Hijri (islamic) calendars are lunar calendars, it was necessary to [define a standard](https://github.com/khawarizmus/hijri-week-calendar-proposal) for them which has [slightly modified rules](#rules) from that of the ISO week based on the Gregorian calendar. Not withstanding the foregoing, the system shares many of the rules defined by the ISO 8601 making it compliant with the ISO standard.

This implementation aims to standardise rules across all varieties of Hijri (islamic) calendars. For detailed information on specific compatibility requirements, please refer to the [Compatible Calendars](#compatible-calendars) section.

Expand Down

0 comments on commit 022ed1a

Please sign in to comment.