Merge pull request #243 from sebbo2002/feature/vtimezone

Add support for external VTimezone generator

.github/workflows/release-bot.yml

@@ -13,8 +13,6 @@ jobs:
     steps:
       - name: ☁️ Checkout Project
         uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - name: ☁️ Checkout ReleaseBot
         uses: actions/checkout@v2
         with:

README.md

@@ -69,8 +69,29 @@ objects. You can also pass a string which is then passed to javascript's `Date`
 
 It is recommended to use UTC time as far as possible. `ical-generator` will output all time information as UTC time as
 long as no time zone is defined. For day.js, a plugin is necessary for this, which is a prerequisite. If a time zone is
-set, `ical-generator` assumes that the given time matches the time zone. If a `moment-timezone` object or Luxon's
-`setZone` method works, `ical-generator` sets it according to the time zone set in the calendar/event.
+set, `ical-generator` assumes that the given time matches the time zone. If a time zone is used, it is also recommended
+to use a VTimezone generator. Such a function generates a VTimezone entry and returns it. For example, ical-timezones can
+be used for this:
+
+```typescript
+import ical from 'ical-generator';
+import {getVtimezoneComponent} from '@touch4it/ical-timezones';
+
+const cal = new ICalCalendar();
+cal.timezone({
+    name: 'FOO',
+    generator: getVtimezoneComponent
+});
+cal.createEvent({
+    start: new Date(),
+    timezone: 'Europe/London'
+});
+```
+
+If a `moment-timezone` object or Luxon's `setZone` method works, `ical-generator` sets it according to the time zone set
+in the calendar/event.
+
+
 
 
 ## 🚦 Tests

package.json

@@ -39,6 +39,7 @@
     "@semantic-release/github": "^7.2.0",
     "@semantic-release/npm": "^7.1.0",
     "@semantic-release/release-notes-generator": "^9.0.2",
+    "@touch4it/ical-timezones": "^1.6.0",
     "@types/luxon": "^1.26.3",
     "@types/mocha": "^8.2.2",
     "@types/node": "^14.14.35",
@@ -60,6 +61,7 @@
     "typescript": "^4.2.3"
   },
   "peerDependencies": {
+    "@touch4it/ical-timezones": "^1.6.0",
     "@types/luxon": "^1.26.0",
     "@types/mocha": "^8.2.1",
     "@types/node": "^14.14.31",