From b21954df075056b710ef58239baafb1ea8b8917e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rk=20Vince=20Varga?= Date: Tue, 12 Nov 2024 12:48:37 +0100 Subject: [PATCH] Clarify usage --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa19642..3415fab 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,23 @@ Currently designed to run on CloudFlare Workers. -## Getting Started +## Usage + +Deploy to CloudFlare Workers. + +```bash +npx wrangler deploy +``` + +> Example: Filter for events with titles excluding specific strings +> +> ```bash +> curl https://${WORKER_URL}/?cal=${SOURCE_ICAL_FILE_URL}&titleDoesNotContain=birthday,Birthday +> ``` + +This URL can be provided to a calendar software supporting RFC 5545 calendar filer as a subscription. + +## Development See the [CloudFlare Workers guide](https://developers.cloudflare.com/workers/get-started/guide/) to get started with development.