Clarify usage

Markcanfly · Nov 12, 2024 · b21954d · b21954d
1 parent 68983ae
commit b21954d
Showing 1 changed file with 17 additions and 1 deletion.
diff --git 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.