Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev #57

Merged
merged 7 commits into from
Dec 13, 2023
Merged

Dev #57

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down Expand Up @@ -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:
Expand All @@ -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>
```

Expand All @@ -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
Expand Down
Loading