Skip to content

Commit

Permalink
improved documentation and cleaned up workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
treehousetim committed Dec 30, 2021
1 parent 4b58eb1 commit c985a39
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/php.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ jobs:
- name: Use PHP 7.1
run: |
sudo update-alternatives --set php /usr/bin/php7.1
php -v
- name: Validate composer.json and composer.lock
run: composer validate
Expand Down
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,41 @@ Bank Holiday Date calculations in PHP for United States of America and Canada.
`composer require treehousetim/bank-holidays`

## Canada
Canadian bank holidays are difficult to find authoritative information for. I've done the best I can with current information. Contact me if you find authoritative sources of the rules to follow (not just a list of dates).
Canadian bank holidays are difficult to find authoritative information for. I've done the best I can with current information. Open an issue if you find authoritative sources of the rules to follow (not just a list of dates).

### List of Canadian Bank Holidays
* New Year's Day;
* Family Day;
* Good Friday;
* Easter Monday;
* Victoria Day;
* Canada Day;
* Civic Holiday;
* Labor Day;
* Thanksgiving Day;
* Remembrance Day;
* Christmas Day;
* Boxing Day;

## United States
Not all holidays are observed as bank holidays in the United States.
If a holiday falls on a Saturday, it is not observed. If it falls on a Sunday it is observed on Monday.

### List of US Bank Holidays

* New Year's Day
* Martin Luther King Jr. Day
* Presidents' Day
* Memorial Day
* Juneteenth
* Independence Day
* Labor Day
* Columbus Day
* Veterans Day
* Thanksgiving Day
* Christmas Day


## Getting Detail
Both `usa` and `canada` classes implement the following abstract methods.

Expand Down

0 comments on commit c985a39

Please sign in to comment.