Skip to content

Commit

Permalink
Launch version 0.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
gRegorLove committed Mar 1, 2024
2 parents 278a203 + f95516e commit a5184b7
Show file tree
Hide file tree
Showing 6 changed files with 2,197 additions and 362 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Convert microformats [h-event](https://microformats.org/wiki/h-event) to iCalend
Note: This is currently very much an _alpha_ version, doing the minimal amount I needed it to do. I plan to expand it, though. Issue reports are welcomed.

## Requirements
* PHP 5.6+
* PHP 7.4+
* [php-mf2](https://github.com/indieweb/php-mf2) - included via Composer
* [php-mf-cleaner](https://github.com/barnabywalters/php-mf-cleaner) - included via Composer

Expand All @@ -22,7 +22,7 @@ It is recommended to install via [Composer](https://getcomposer.org/). This proj
}
],
"require": {
"gregorlove/mf2-to-icalendar": "dev-master"
"gregorlove/mf2-to-icalendar": "dev-main"
}
}
Expand Down Expand Up @@ -68,10 +68,6 @@ define('PRODID_DOMAIN', 'example.com');
Mf2toiCal\convert('https://example.com/event');
```

### Exceptions

If the specified URL does not have h-event microformats, an Exception is thrown. Your code should be set up to handle that Exception.

### Language and Character Set

This script defaults to language `en` and charset `utf-8` for text content lines in the generated .ics file. You can specify different options when calling `convert()`:
Expand All @@ -85,6 +81,12 @@ Detecting the language from the HTML and using that is on my TODO list.

## Changelog

### 0.0.4
2024-02-29
* Update dependencies
* Add type declarations and strict typing
* Fix errors

### 0.0.3
2020-12-23
* No longer throws an Exception if no h-event microformats found when converting. Instead will generate an "empty" iCalendar.
Expand Down
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"name": "gregorlove/mf2-to-icalendar",
"description": "Convert microformats h-event to iCalendar",
"require": {
"php": ">=5.6.0",
"mf2/mf2": "^0.4",
"barnabywalters/mf-cleaner": "^0.1.4"
"php": ">=7.4",
"mf2/mf2": "^0.5",
"barnabywalters/mf-cleaner": "^0.2"
},
"require-dev": {
"phpunit/phpunit": "^5"
"phpunit/phpunit": "^9"
},
"autoload": {
"psr-4": {
Expand Down
Loading

0 comments on commit a5184b7

Please sign in to comment.