diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2b4b4b --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Calendar related datasets + +This package contains calendar related data that can be imported into any application. + +## Datasets + +Name | Contents +---|--- +`bankholidays.se` | Swedish bank holidays + +## Usage + +Open the dataset and iterate the data: + +```php +$dm = new NoccyLabs\Dataset\DatasetManager(); +$ds = $dm->openDataset("noccylabs/dataset-calendar#bankholidays.se"); +// Iterate the records +foreach ($ds as $row) { + // ... +} +``` diff --git a/composer.json b/composer.json index 016760a..9d1fd3b 100644 --- a/composer.json +++ b/composer.json @@ -1,4 +1,8 @@ { "name": "noccylabs/dataset-calendar", - "description": "Dataset containing bank holidays and other calendar info" + "description": "Dataset containing bank holidays and other calendar info", + "license": "CC-BY-SA-4.0", + "suggest": { + "noccylabs/dataset": "to parse the dataset" + } }