Merge pull request #57 from add2cal/dev

Dev

Author: jekuer

.github/CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
+contributing@add-to-calendar-pro.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/CONTRIBUTING.md

@@ -77,7 +77,7 @@ Adhering to the following process is the best way to get your work included in t
 
     ```bash
     # Clone your fork of the repo
-    git clone https://github.com/<your-username>/add-to-calendar-button-react.git
+    git clone https://github.com/add2cal/add-to-calendar-button-react.git
     # Navigate to the newly cloned directory
     cd add-to-calendar-button-react
     # Assign the original repo to a remote called "upstream"

.github/workflows/codeql-analysis.yml

@@ -22,7 +22,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2

.github/workflows/npm-publish.yml

@@ -11,21 +11,21 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - run: npm ci
       - run: npm test
 
   build-and-publish:
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           registry-url: https://registry.npmjs.org/
           cache: 'npm'
       - run: npm ci

.github/workflows/tests.yml

@@ -9,12 +9,12 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest]
-        node-version: ['18']
+        node-version: ['18', '20']
         toolchain: [stable]
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - name: Run tests

README.md

@@ -1,7 +1,7 @@
 ![Add to Calendar Button React Wrapper](https://github.com/add2cal/add-to-calendar-button-react/blob/main/assets/readme-header.png?raw=true)
 
 ![Version](https://img.shields.io/npm/v/add-to-calendar-button-react?style=for-the-badge&label=Version)
-[![Parent Script Version](https://img.shields.io/badge/Parent%20Script%20Version-v2.4.3-blue?style=for-the-badge)](https://github.com/add2cal/add-to-calendar-button)
+[![Parent Script Version](https://img.shields.io/badge/Parent%20Script%20Version-v2.5.0-blue?style=for-the-badge)](https://github.com/add2cal/add-to-calendar-button)
 [![npm bundle size](https://img.shields.io/bundlephobia/minzip/add-to-calendar-button-react?style=for-the-badge)](https://www.npmjs.com/package/add-to-calendar-button-react)
 [![npm Installations](https://img.shields.io/npm/dt/add-to-calendar-button-react?label=npm%20Installations&style=for-the-badge)](https://www.npmjs.com/package/add-to-calendar-button-react)
 
@@ -84,6 +84,22 @@ Simple and convenient integration of 1 or many buttons, optimized to be used as
 
 <br />
 
+## 🚀 Go PRO
+
+- ics file generation and hosting for better compatibility.
+- RSVP, incl. automatic updates sent to attendees, GDPR features, and more.
+- More customization - all no-code.
+- API, webhooks, and more technical toys.
+- Share events among all kinds of channels - email, social media, ...
+
+Check the details at [add-to-calendar-pro.com](https://add-to-calendar-pro.com)!
+
+<br />
+
+---
+
+<br />
+
 ## 📦 Installation
 
 Install the package using the following npm command:
@@ -106,11 +122,14 @@ import { AddToCalendarButton } from 'add-to-calendar-button-react';
 
 Use the componet inside your code and declare any options as props. You will get warned about any type misconfiguration.
 
+Calendar type options and time zone information are not required, but recommended.
+
 ```javascript
 <AddToCalendarButton
   name="Test-Event"
   startDate="2023-05-22"
   options={['Apple','Google','Yahoo','iCal']}
+  timeZone="America/Los_Angeles"
 ></AddToCalendarButton>
 ```
 
@@ -122,6 +141,14 @@ If you need to use the type explicitely, you can import it via:
 import type { AddToCalendarButtonType } from 'add-to-calendar-button-react';
 ```
 
+<br /><br />
+
+When using the PRO version, you can keep it even shorter, as you would only need the proKey.
+
+```javascript
+<AddToCalendarButton proKey="prokey-of-your-event"></AddToCalendarButton>
+```
+
 <br />
 
 ### All options and hidden features