Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nielsvanpach committed Jan 20, 2024
1 parent a69a226 commit 44a846a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ $holidays = Holidays::for(Belgium::make())->get();
```

Alternatively, you could also pass an [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) code to the `for` method.
In case of region based holidays, these will not be included. Use a country class instead.

```php
use Spatie\Holidays\Holidays;
Expand Down Expand Up @@ -87,6 +88,9 @@ use Spatie\Holidays\Holidays;
Holidays::for('be')->getName('2024-01-01'); // Nieuwjaar
```

### Package limitations
1. Islamic holidays are not supported (yet)

## Contributing a new country

If you want to add a new country, you can create a pull request.
Expand Down

0 comments on commit 44a846a

Please sign in to comment.