<commit_before>![ical-generator Logo](https://d.sebbo.net/ical-generator-logo-AvKRjlfYJe4OlPV9l0zgSDlgyW59bOzFzjUUTG9tGM0ySKQuZ1PbzkZO9XYZ1vjLt8XwRgjZH2CYw22vD9OTzFeTvEWlqPFfyuox.jpg)

# ical-generator

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
![Size](https://img.shields.io/bundlephobia/min/ical-generator?style=flat-square)
[![Status](https://img.shields.io/github/workflow/status/sebbo2002/ical-generator/Tests?style=flat-square)](https://github.com/sebbo2002/ical-generator/actions)
![Dependencies](https://img.shields.io/depfu/sebbo2002/ical-generator?style=flat-square)

`ical-generator` is a small but fine library with which you can very easily create a valid iCal calendars, for example
to generate subscriptionable calendar feeds.

<table><tr><td>
<b>⚠️ Version 2.0.0</b><br /><br />
<p>You are looking at the readme of the new version 2.0.0, which is currently still under development. The new version is
a complete rewrite in Typescript, but I tried to keep most of the API. Nevertheless, there are some changes. You can
install this future version by running <code>npm i ical-generator@next</code>.</p>

<p>If you are looking for the readme of the current version, you can find it
<a href="https://github.com/sebbo2002/ical-generator/blob/main/README.md">here</a>.</p>
<p>If you want to help out or want to know what's in the pipeline with the new version, you're welcome to take a look
<a href="https://github.com/sebbo2002/ical-generator/issues?q=milestone%3A%22v2.0.0+%F0%9F%8E%89%22+">here</a> and get an idea of
what's in the new version.</p>
</td></tr></table>


## 📦 Installation

	npm install ical-generator


## ⚡️ Quick Start

```javascript
import ical from 'ical-generator';
import http from 'http';

const calendar = ical({name: 'my first iCal'});
calendar.createEvent({
    start: moment(),
    end: moment().add(1, 'hour'),
    summary: 'Example Event',
    description: 'It works ;)',
    location: 'my room',
    url: 'http://sebbo.net/'
});
<commit_msg>docs(Readme): Remove section about upcoming 2.0.0<commit_after>![ical-generator Logo](https://d.sebbo.net/ical-generator-logo-AvKRjlfYJe4OlPV9l0zgSDlgyW59bOzFzjUUTG9tGM0ySKQuZ1PbzkZO9XYZ1vjLt8XwRgjZH2CYw22vD9OTzFeTvEWlqPFfyuox.jpg)

# ical-generator

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
![Size](https://img.shields.io/bundlephobia/min/ical-generator?style=flat-square)
[![Status](https://img.shields.io/github/workflow/status/sebbo2002/ical-generator/Tests?style=flat-square)](https://github.com/sebbo2002/ical-generator/actions)
![Dependencies](https://img.shields.io/depfu/sebbo2002/ical-generator?style=flat-square)

`ical-generator` is a small but fine library with which you can very easily create a valid iCal calendars, for example
to generate subscriptionable calendar feeds.


## 📦 Installation

	npm install ical-generator


## ⚡️ Quick Start

```javascript
import ical from 'ical-generator';
import http from 'http';

const calendar = ical({name: 'my first iCal'});
calendar.createEvent({
    start: moment(),
    end: moment().add(1, 'hour'),
    summary: 'Example Event',
    description: 'It works ;)',
    location: 'my room',
    url: 'http://sebbo.net/'
});

{'fraction_non_alphanumeric': 0.1492491572172847, 'fraction_numerical': 0.026356114005516396, 'mean_word_length': 5.217142857142857, 'pattern_counts': {'":': 0, '<': 25, '<?xml version=': 0, '>': 25, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1284109', 'n_tokens_mistral': 1242, 'n_tokens_neox': 1147, 'n_words': 259}